Creates a new MessageEnvelope, which adds a correlation id, message id, and a type to the data being sent/received.
(optional) transaction id to trace execution through call chain.
a string value that defines the message's type.
the data being sent/received.
The unique business transaction id that is used to trace calls across components.
The stored message.
The message's auto-generated ID.
String value that defines the stored message's type.
The time at which the message was sent.
the value that was stored in this message as a JSON string.
the information stored in this message as a UTF-8 encoded string.
the lock token that this MessageEnvelope references.
Stores the given value as a JSON string.
the value to convert to JSON and store in this message.
Stores the given string.
the string to set. Will be converted to a buffer, using UTF-8 encoding.
Sets a lock token reference for this MessageEnvelope.
the lock token to reference.
Convert's this MessageEnvelope to a string, using the following format:
"[<correlation_id>,<message_type>,<message.toString>]"
.
If any of the values are null
, they will be replaced with ---
.
the generated string.
Generated using TypeDoc
Allows adding additional information to messages. A correlation id, message id, and a message type are added to the data being sent/received. Additionally, a MessageEnvelope can reference a lock token.
Side note: a MessageEnvelope's message is stored as a buffer, so strings are converted using utf8 conversions.