Plugin Commands: Messaging Server#
The messaging-server plugin contributes CLI commands to the application framework to be used for manipulating messages in a server context.
Macros#
plugin messaging-server append [message:-1]
plugin messaging-server cancel [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]
plugin messaging-server confirm not
plugin messaging-server confirm req
plugin messaging-server display [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]
plugin messaging-server id [messageId:4]
plugin messaging-server importance critical
plugin messaging-server importance high
plugin messaging-server importance low
plugin messaging-server importance medium
plugin messaging-server invalid [endpoint:1]
plugin messaging-server message [message:-1]
plugin messaging-server print [endpoint:1]
plugin messaging-server relative-time [time:4] [duration:4]
plugin messaging-server time [time:4] [duration:2]
plugin messaging-server transmission both
plugin messaging-server transmission ipan
plugin messaging-server transmission normal
plugin messaging-server valid [endpoint:1]
Macro Definition Documentation#
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_APPEND#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_APPEND
plugin messaging-server append [message:-1]
Append an additional string to the message contained in the message plugin
message - OCTET_STRING - the string to append to the current message
4093 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CANCEL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CANCEL
plugin messaging-server cancel [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]
Cancel the message.
nodeId - INT16U - The destination of the message.
srcEndpoint - INT8U - The source endpoint of the message.
dstEndpoint - INT8U - The destination endpoint of the message.
4101 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_NOT#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_NOT
plugin messaging-server confirm not
Set the message confirmation to not used.
4106 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_REQ#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_REQ
plugin messaging-server confirm req
Set message confirmation to required.
4111 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_DISPLAY#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_DISPLAY
plugin messaging-server display [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]
Display the message.
nodeId - INT16U - The destination of the message.
srcEndpoint - INT8U - The source endpoint of the message.
dstEndpoint - INT8U - The destination endpoint of the message.
4119 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_ID#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_ID
plugin messaging-server id [messageId:4]
Set the message id for the message contained in the messaging plugin
messageId - INT32U - message id
4125 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_CRITICAL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_CRITICAL
plugin messaging-server importance critical
Set the message importance to critical.
4130 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_HIGH#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_HIGH
plugin messaging-server importance high
Set the message importance to high.
4135 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_LOW#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_LOW
plugin messaging-server importance low
Set the message importance to low.
4140 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_MEDIUM#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_MEDIUM
plugin messaging-server importance medium
Set the message importance to medium.
4145 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_INVALID#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_INVALID
plugin messaging-server invalid [endpoint:1]
Set the message validity to invalid.
endpoint - INT8U - The relevant endpoint.
4151 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_MESSAGE#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_MESSAGE
plugin messaging-server message [message:-1]
Set the message used by the message plugin.
message - OCTET_STRING - The message to set
4157 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_PRINT#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_PRINT
plugin messaging-server print [endpoint:1]
Print the message info.
endpoint - INT8U - The relevant endpoint.
4163 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_RELATIVE_TIME#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_RELATIVE_TIME
plugin messaging-server relative-time [time:4] [duration:4]
Set the relative time on the message.
time - INT32U - number of minutes to add to the message time above the current time
duration - INT32U - duration in minutes for the message to be valid
4170 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TIME#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TIME
plugin messaging-server time [time:4] [duration:2]
Set the start time and duration for the message used by the message plugin.
time - INT32U - start time
duration - INT16U - duration
4177 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_BOTH#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_BOTH
plugin messaging-server transmission both
Set the message control bit mask in the message to normal and anonymous.
4182 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_IPAN#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_IPAN
plugin messaging-server transmission ipan
Set the message control bit mask in the message to anonymous.
4187 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_NORMAL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_NORMAL
plugin messaging-server transmission normal
Sets the message control bit mask to normal transmission.
4192 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_VALID#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_VALID
plugin messaging-server valid [endpoint:1]
Set the message validity to valid.
endpoint - INT8U - The relevant endpoint.
4198 of file ./app/framework/test/headers/cli.doc