import MessageBus from 'devapt-core-common/js/messaging/message_bus.js'

public class | source

MessageBus

Extends:

Loggable → Errorable → Settingsable → Stateable → Instance → MessageBus

Constructor Summary

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

Member Summary

Public Members
public	is_message_bus: boolean Class type flag.

Private Members
private	_bus_engine: *
private	_input_stream: *
private	_recipients: {}
private	_recipients_handlers: {}

Method Summary

Public Methods
public	get_bus_engine(): BusEngine Get bus engine.
public	get_input_stream(): Stream Get stream to populate the bus.
public	msg_add_recipient(arg_name: string, arg_instance: DistributedInstance): nothing Add a recipient.
public	msg_has_recipient(arg_name: arg_name): boolean Test if bus has given named recipient.
public	msg_post(arg_msg: DistributedMessage): boolean Send a message into a channel.
public	msg_recipients(arg_page_size: integer, arg_page_index: integer): object Get paged recipients list.
public	msg_register(arg_distributed_instance: DistributedInstance, arg_channel: string, arg_method: string, arg_alias: string): function Register a DistributedInstance recipient.
public	msg_remove_recipient(arg_name: string): nothing Remove a recipient.
public	msg_subscribe(arg_channel: string, arg_handler: function, arg_filter: string \| function): function Subscribe on channel inputs.
public	normalize_msg(arg_msg: object): DistributedMessage \| undefined Normalize given message.

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.

Public Constructors

public constructor(arg_name: string, arg_bus_engine: BusEngine, arg_settings: object, arg_log_context: string): nothing source

Create a bus.

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

Engine API:

->get_bus_engine():BusEngine

Stream API:
->get_input_stream():Stream - get input stream to populate the bus.

Message API:
 ->msg_recipients(arg_page_size=999999, arg_page_index=0):array - get paged recipients list.

->msg_post(arg_msg:DistributedMessage):boolean - send a DistributedMessage instance.

->msg_subscribe(arg_channel:string, arg_handler:f(msg), arg_filter:string|object):unsubscribe function - subscribe to messages of the bus.

->msg_register(arg_distributed_instance,arg_channel,arg_method='receive_msg'):function - register a DistributedInstance recipient. ->msg_has_recipient(arg_name):boolean - test if the bus has given named recipient. ->msg_add_recipient(arg_name, arg_instance='remote') - add a bus recipient. ->msg_remove_recipient(arg_name) - remove a bus recipient.

->normalize_msg(arg_msg):DistributedMessage|undefined - Normalize given message.

Override:

Instance#constructor

Params:

Name	Type	Attribute	Description
arg_name	string		instance name.
arg_bus_engine	BusEngine		bus engine.
arg_settings	object		settings.
arg_log_context	string		trace context.

Return:

nothing

Public Members

public is_message_bus: boolean source

Class type flag.

Private Members

private _bus_engine: * source

private _input_stream: * source

private _recipients: {} source

private _recipients_handlers: {} source

Public Methods

public get_bus_engine(): BusEngine source

Get bus engine.

Return:

BusEngine

public get_input_stream(): Stream source

Get stream to populate the bus.

Return:

Stream

input bus stream.

public msg_add_recipient(arg_name: string, arg_instance: DistributedInstance): nothing source

Add a recipient.

Params:

Name	Type	Attribute	Description
arg_name	string		recipient name.
arg_instance	DistributedInstance		distributed recipient instance (default:'remote').

Return:

nothing

public msg_has_recipient(arg_name: arg_name): boolean source

Test if bus has given named recipient.

Params:

Name	Type	Attribute	Description
arg_name	arg_name		recipient name.

Return:

boolean

public msg_post(arg_msg: DistributedMessage): boolean source

Send a message into a channel.

Params:

Name	Type	Attribute	Description
arg_msg	DistributedMessage		distributed message instance.

Return:

boolean

success or failure.

public msg_recipients(arg_page_size: integer, arg_page_index: integer): object source

Get paged recipients list.

Params:

Name	Type	Attribute	Description
arg_page_size	integer		recipients list page size.
arg_page_index	integer		recipients list page index.

Return:

object

paged result { count:recipients count, page_size:..., page_count:..., page_index:..., page_values:[] }

public msg_register(arg_distributed_instance: DistributedInstance, arg_channel: string, arg_method: string, arg_alias: string): function source

Params:

Name	Type	Attribute	Description
arg_distributed_instance	DistributedInstance		distributed recipient instance.
arg_channel	string		channel name string.
arg_method	string		message handler method name string.
arg_alias	string		instance alias name string (optional, default undefined).

Return:

function

unsubscribe function.

public msg_remove_recipient(arg_name: string): nothing source

Remove a recipient.

Params:

Name	Type	Attribute	Description
arg_name	string		recipient name.

Return:

nothing

public msg_subscribe(arg_channel: string, arg_handler: function, arg_filter: string | function): function source

Subscribe on channel inputs.

Params:

Name	Type	Attribute	Description
arg_channel	string		channel name string.
arg_handler	function		f(payload)
arg_filter	string \| function		filter string or function.

Return:

function

unsubscribe function.

public normalize_msg(arg_msg: object): DistributedMessage | undefined source

Normalize given message.

Params:

Name	Type	Attribute	Description
arg_msg	object		message to normalize.

Return:

DistributedMessage | undefined

normalized message.