Comms properties

The communication that the Comms module manages is file-based. The input and output files used for this communication must be configured. To configure the Comms File implementation, use these system properties:

System property	Default value	Description
mbs.comms	–	To enable the Comms File module implementation the value must be set to commsFile before framework startup in one of the configuration .prs files
mbs.commsFile.out	out	The path to the file that the module will use to send messages through.
mbs.commsFile.in	in	The path to the file that the module will use to receive messages from.
mbs.mbsa.ping.disable	false	If set to true disables the heartbeat notifications (ping) that the framework sends.
mbs.mbsa.ping.timeout	30s	If the mbs.mbsa.ping.disable is set to false then the interval for sending heartbeat notification messages (ping) is set to the value provided.

Supported messages

There are two basic types of messages that the module supports:

Framework life-cycle messages – generated when the state of the framework is changed or must be changed. The messages, that the module supports and sends to the output file when the framework's state is changed, are:
- FW_STARTING – the framework is starting
- FW_STARTED – the framework is started
- FW_RESTART – the framework is restarted
- FW_STOPPING – the framework is stopping
- FW_STOPPED – the framework is stopped
There is only one message that the module supports for receiving and is used to control the state of the framework instance:
- FW_EXIT – When sent to the input file that the module uses, the framework instance is stopped and the FW_STOPPING and FW_STOPPED messages are sent to the output file.

Framework manager instances messages – generated by the FaultManager, UpdateManager and the RestartManager instances. The module also supports the heartbeat functionality – sending periodical notification messages (ping). These messages consist of three parts separated by "|":

M_ID – the ID of the manager that generated the message
ACTION – the ID of the action that caused message generation
DATA – the content of the message and any data needed for further processing

Examples of the messages generated by the manager instances:

Sample action ID	Sample supported message	Manager instance that generated the message
FaultManager.LOG	M_ID:com.prosyst.mbsa.faultmanager\|ACTION:0\|DATA:[some data]	com.prosyst.mbs.framework.fm.FaultManager
UpdateManager.ACTION_UPDATE_OSGI	M_ID:com.prosyst.mbsa.updatemanager\|ACTION:300\|DATA:\updatelocation	com.prosyst.mbs.framework.updatemanager.UpdateManager
RestartManager.ACTION_RESTART_FW	M_ID:com.prosyst.mbsa.restartmanager\|ACTION:200\|DATA:[cause of restart]	com.prosyst.mbs.framework.restartmanager.RestartManager
0 - defined by the Comms File Impl	M_ID:com.prosyst.mbsa.mbsmanager\|ACTION:0\|DATA:FW_PING	The module instance – heartbeat message (ping).