GENERICMESSAGE::message

Description

The GENERICMESSAGE::message commands returns or sets values in the message routing framework.

Syntax

GENERICMESSAGE::message src [<src_addr>]
GENERICMESSAGE::message dst [<dst_addr>]
GENERICMESSAGE::message is_request [true OR false]
GENERICMESSAGE::message length
GENERICMESSAGE::message text [<new_text>]
GENERICMESSAGE::message data [<new_data>]
GENERICMESSAGE::message no_response [true OR false]
GENERICMESSAGE::message create [<text> [<destination_address>]]
GENERICMESSAGE::message drop <reason>
GENERICMESSAGE::message status
GENERICMESSAGE::message request_sequence_number [<number>]

GENERICMESSAGE::message src [<src_addr>]

  • Returns (or sets) the message’s source address.

Note: read/write in GENERICMESSAGE_INGRESS,MR_INGRESS. Read-Only in GENERICMESSAGE_EGRESS,MR_EGRESS,MR_FAILED

GENERICMESSAGE::message dst [<dst_addr>]

  • Returns (or sets) the message’s destination address.

Note: read/write in GENERICMESSAGE_INGRESS,MR_INGRESS. Read-Only in GENERICMESSAGE_EGRESS,MR_EGRESS,MR_FAILED

GENERICMESSAGE::message is_request [true OR false]

  • Returns true if the message is a request message, or can manually identify the message with the true/false flag

Note: read/write only in GENERICMESSAGE_INGRESS

GENERICMESSAGE::message length

  • Returns the message size in bytes.

GENERICMESSAGE::message text [<new_text>]

  • Returns (or sets) the message’s text.

GENERICMESSAGE::message data [<new_data>]

  • Returns (or sets) the message data (as an array of bytes)

GENERICMESSAGE::message no_response [true OR false]

  • Returns true if the message is asynchronous, or an manually identify the message with the true/false flag

GENERICMESSAGE::message create [<text> [<destination_address>]]

  • Creates a new empty message that can be sent. Once created, a GENERICMESSAGE_INGRESS event shall be raised where the script writer will be able to populate the message. Upon completion of the script, the message will be forwarded for routing.

GENERICMESSAGE::message drop <reason>

  • Terminates processing of the current message.

GENERICMESSAGE::message status

  • Returns the route status. Please see MR::message status

GENERICMESSAGE::message request_sequence_number [<number>]

  • Returns the request_sequence_number used to save the last hop of a request message. This will be valid during GENERICMESSAGE_EGRESS of request messages. During GENERICMESSAGE_INGRESS of response messages, it will contain the sequence number of the oldest un-responded request.
  • Sets the request_sequence_number used to save the last hop of a request message. During GENERICMESSAGE_INGRESS, setting this field will allow associting a response message with an un-responded request message and the request message’s lasthop will be used as the next hop for the message.

Examples