import SocketIOBusEngine from 'devapt-core-common/js/messaging/socketio_bus_engine.js'

public class | source

SocketIOBusEngine

Extends:

Loggable → Errorable → Settingsable → Stateable → Instance → BusEngine → SocketIOBusEngine

SocketIO based bus engine class for message bus client or server.

Example:

API:
  ->constructor(arg_name,arg_settings,arg_log_context,arg_logger_manager).

->channel_list():array                           - List engine channels.
  ->channel_add(arg_channel):nothing               - Add a channel.
  ->channel_send(arg_channel, arg_payload):nothing - Send a message into a channel.
  ->channel_on(arg_channel, arg_handler):nothing   - Subscribe on channel inputs.
  ->channel_transform(arg_in_channel, arg_out_channel, arg_xform_handler):nothing - Transform payload of input channel to output channel.

Constructor Summary

Public Constructor
public	constructor(arg_name: string, arg_settings: object, arg_log_context: string, arg_logger_manager: LoggerManager): nothing Create a bus.

Member Summary

Public Members
public	is_socketio_bus_engine: boolean Class type flag.

Private Members
private	_channels: {}
private	_server: *
private	_subscribers: {}

Method Summary

Public Methods
public	channel_add(arg_channel: string): nothing Add a channel.
public	channel_list(): array List engine channels.
public	channel_on(arg_channel: string, arg_handler: function, arg_predicate: function): nothing Subscribe on channel inputs.
public	channel_send(arg_channel: string, arg_payload: object): nothing Send a message into a channel.
public	on_bus(arg_socket: , arg_channel: , arg_value: *)
public	on_connect(arg_socket: , arg_channel: )
public	on_disconnect(arg_socket: , arg_channel: )
public	on_error(arg_socket: , arg_channel: , arg_value: *)

Inherited Summary

From class Loggable
public	$context: string Log context.
public	is_loggable: boolean Class type flag.
public	is_trace_enabled: boolean Trace is enabled for this flag.
private	_logger_manager: LoggerManager Logger manager instance (default undefined)
public	debug(args: string \| array): nothing Trace DEBUG formatted message.
public	disable_trace(): nothing Disable traces.
public	enable_trace(): nothing Enable traces.
public	enter_group(arg_group: string): nothing Trace INFO message on "enter trace group".
public	error(args: string \| array): nothing Trace ERROR formatted message.
public	get_class(): string Define get class name method for non Instance classes.
public	get_context(): string Get instance context.
public	get_logger_manager(): LoggerManager Get logger manager.
public	get_name(): string Define get instance name method for non Instance classes.
public	get_trace(): boolean Get trace flag.
public	info(args: string \| array): nothing Trace INFO formatted message.
public	leave_group(arg_group: string): nothing Trace INFO message on "leave trace group".
public	separate_level_1(): nothing Trace INFO trace level 1 separator.
public	separate_level_2(): nothing Trace INFO trace level 2 separator.
public	separate_level_3(): nothing Trace INFO trace level 3 separator.
public	set_trace(arg_value: boolean): nothing Set trace flag.
public	should_trace(arg_traces_cfg: object): boolean Calculate should trace flag.
public	should_trace_class(arg_traces_cfg: object): boolean Calculate should trace flag for classes.
public	should_trace_collection_item(arg_traces_cfg: object, arg_collection_name: string, arg_this_item_accessor: string): boolean Calculate should trace flag for given collection of names or patterns.
public	should_trace_module(arg_traces_cfg: object): boolean Calculate should trace flag for modules.
public	should_trace_name(arg_traces_cfg: object): boolean Calculate should trace flag for instances names.
public	toggle_trace(): boolean Toggle trace flag.
public	update_trace_enabled(): nothing Update trace enabled flag.
public	warn(args: string \| array): nothing Trace WARN formatted message.

From class Errorable
private	_error_msg: string Error text (default null).
private	_has_error: boolean Has error flag (default false).
public	error(arg_msg: string): nothing Set an error.
public	error_not_implemented() Default helper for "not implemented" error.
public	get_error_msg(): string Get error message.
public	has_error(): boolean Test is an error is set.

From class Settingsable
public	$settings: object \| Immutable.Map Instance settings (default undefined).
public	is_settable: boolean Class type flag.
public	get_setting(arg_name: string \| array, arg_default: any): any Get a value in settings for given key.
public	get_setting_js(arg_name: string \| array, arg_default: any): any Get a value in settings for given key.
public	get_settings(): Immutable.Map Get instance settings.
public	get_settings_js(): Immutable.Map Get instance settings.
public	has_setting(arg_name: string): boolean Test if a key exists in settings.
public	set_setting(arg_name: string, arg_value: any): nothing Set a value in settings for given key.
public	set_settings(arg_settings: Immutable.Map): nothing Set instance settings.

From class Stateable
public	is_stateable: boolean Class type flag.
public	state_path: array State path in runtime state.
private	_initial_state: object Initial state.
private	_runtime: Runtime Runtime isntance.
private	_state_store: StateStore State store.
private	_state_value_listeners: array State changes handlers.
public	dispatch_action(arg_action_type: string \| object, arg_options: object \| undefined): nothing Dispatch a state action.
public	get_initial_state(): Immutable.Map Get initial state, an immutable object from a Redux data store.
public	get_name(): string Get name.
public	get_runtime(): RuntimeBase Get runtime instance.
public	get_state(): Immutable.Map Get current state, an immutable object from a Redux data store.
public	get_state_js(): object Get current state, an immutable object from a Redux data store.
public	get_state_path(): array Get state path into a Redux data store.
public	get_state_store(): object Get state store.
public	get_state_value(arg_key_or_path: string \| array, arg_default_value: any): any Get a state entry.
public	handle_state_change(arg_previous_state: Immutable.Map, arg_new_state: Immutable.Map): nothing Handle component state changes.
public	register_state_value_change_handle(arg_path: string \| array, arg_listener: string \| function): nothing Register a state value change listener.

From class Instance
public	$class: string Instance class name.
public	$id: string Instance id.
public	$name: string Instance name.
public	$type: string Instance collection name.
public	is_instance: boolean Class type flag.
public	is_loaded: boolean Instance is loaded flag.
public	get_class(): string Get instance class.
public	get_descriptor(): object Get instance description: {$type:..., $class:..., $id:..., $name:...}.
public	get_descriptor_string(): string Get instance description string: $type:..., $class:..., $id:..., $name:....
public	get_id(): string Get instance unique id.
public	get_name(): string Get instance unique name.
public	get_type(): string Get instance type.
public	is_browser(): boolean Test if this code run inside a browser.
public	is_server(): boolean Test if this code run on a browser.
public abstract	load(): nothing Load instance settings.

From class BusEngine
public	is_bus_engine: boolean Class type flag.
private	_engine_host: *
private	_engine_port: *
private	_engine_protocole: *
private	_engine_type: *
private	_engine_url: *
public	channel_add(arg_channel: string): nothing Add a channel.
public	channel_list(): array List engine channels.
public	channel_on(arg_channel: string, arg_handler: function, arg_predicate: function): function Subscribe on channel inputs.
public	channel_send(arg_channel: string, arg_payload: object): nothing Send a message into a channel.
public	channel_transform(arg_in_channel: string, arg_out_channel: string, arg_handler: function): nothing Transform payload of input channel to output channel.

Public Constructors

public constructor(arg_name: string, arg_settings: object, arg_log_context: string, arg_logger_manager: LoggerManager): nothing source

Create a bus.

Override:

BusEngine#constructor

Params:

Name	Type	Attribute	Description
arg_name	string		instance name.
arg_settings	object		settings.
arg_log_context	string		trace context.
arg_logger_manager	LoggerManager		logger manager object (optional).

Return:

nothing

Public Members

public is_socketio_bus_engine: boolean source

Class type flag.

Private Members

private _channels: {} source

private _server: * source

private _subscribers: {} source

Public Methods

public channel_add(arg_channel: string): nothing source

Add a channel.

Override:

BusEngine#channel_add

Params:

Name	Type	Attribute	Description
arg_channel	string		channel name.

Return:

nothing

public channel_list(): array source

List engine channels.

Override:

BusEngine#channel_list

Return:

array

public channel_on(arg_channel: string, arg_handler: function, arg_predicate: function): nothing source

Subscribe on channel inputs.

Override:

BusEngine#channel_on

Params:

Name	Type	Attribute	Description
arg_channel	string		channel name string.
arg_handler	function		f(payload):nothing
arg_predicate	function		p(payload):boolean

Return:

nothing

public channel_send(arg_channel: string, arg_payload: object): nothing source

Send a message into a channel.

Override:

BusEngine#channel_send

Params:

Name	Type	Attribute	Description
arg_channel	string		channel name string.
arg_payload	object		payload data object.

Return:

nothing

public on_bus(arg_socket: , arg_channel: , arg_value: *) source

Params:

Name	Type	Attribute	Description
arg_socket	*
arg_channel	*
arg_value	*

public on_connect(arg_socket: , arg_channel: ) source

Params:

Name	Type	Attribute	Description
arg_socket	*
arg_channel	*

public on_disconnect(arg_socket: , arg_channel: ) source

Params:

Name	Type	Attribute	Description
arg_socket	*
arg_channel	*

public on_error(arg_socket: , arg_channel: , arg_value: *) source

Params:

Name	Type	Attribute	Description
arg_socket	*
arg_channel	*
arg_value	*

SocketIOBusEngine

Extends:

Example:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(arg_name: string, arg_settings: object, arg_log_context: string, arg_logger_manager: LoggerManager): nothing source

Override:

Params:

Return:

Public Members

public is_socketio_bus_engine: boolean source

Private Members

private _channels: {} source

private _server: * source

private _subscribers: {} source

Public Methods

public channel_add(arg_channel: string): nothing source

Override:

Params:

Return:

public channel_list(): array source

Override:

Return:

public channel_on(arg_channel: string, arg_handler: function, arg_predicate: function): nothing source

Override:

Params:

Return:

public channel_send(arg_channel: string, arg_payload: object): nothing source

Override:

Params:

Return:

public on_bus(arg_socket: *, arg_channel: *, arg_value: *) source

Params:

public on_connect(arg_socket: *, arg_channel: *) source

Params:

public on_disconnect(arg_socket: *, arg_channel: *) source

Params:

public on_error(arg_socket: *, arg_channel: *, arg_value: *) source

Params:

public on_bus(arg_socket: , arg_channel: , arg_value: *) source

public on_connect(arg_socket: , arg_channel: ) source

public on_disconnect(arg_socket: , arg_channel: ) source

public on_error(arg_socket: , arg_channel: , arg_value: *) source