MigratoryDataMessage

Represent a message.

Public Classes

Public Functions

Public Functions Documentation

function MigratoryDataMessage

MigratoryDataMessage(
    String subject,
    byte[] content,
    String closure,
    QoS qos,
    boolean retained,
    String reply_subject
)

Create a MigratoryDataMessage object.

Parameters:

• subject The subject of the message
• content The content of the message
• closure The closure of the message (OPTIONAL)
• qos the QoS level of the message; the default is [QoS.GUARANTEED](/docs/client-api/micropython/classes/interfacemigratorydatamessage_1_1qos/#variable-guaranteed) (OPTIONAL)
• retained indicate whether or not the message should be/was retained by the server; the default is true (OPTIONAL)
• replySubject the reply subject of the message (OPTIONAL)

If a reply subject is attached to a message, the message acts as a request message. The clients which receive a request message will be able to reply by sending back one or more messages having as subject the reply subject.

Note: If the reply subject is not already subscribed, it will be subscribed by the library implicitly, and it can be reused for request/reply interactions (and even for receiving multiple replies to one request). When it is not needed anymore, it should be unsubscribed explicitly.

function get_subject

String get_subject()

Get the subject of the message.

Return: A string representing the subject of the message

function get_content

String get_content()

Get the content of the message.

Return: A string representing the content of the message

function get_closure

String get_closure()

Get the closure of the message.

Return: The closure data of the message

function is_retained

inline boolean is_retained()

Indicate whether or not the message should be/was retained by the server.

Return: true if the message should be, or was, retained by the server

function get_reply_to_subject

String get_reply_to_subject()

Get the subject to be used to reply to this message.

Return: The subject to be used to reply to this message.

A client which receives a message containing a reply subject should interpret the message as a request. It has the option to use the reply subject - extracted from the message with this method - to send a reply.

function get_qos

inline QoS get_qos()

Get the QoS level of the message.

Return: the QoS level of the message

function get_message_type

inline MessageType get_message_type()

Get the MessageType of the message.

Return: the message type of the message

function set_compressed

void set_compressed(
    boolean compressed
)

Set whether to compress the content of the message or not.

Parameters:

• compressed if true, the content of the message will be published in ZLIB-compressed format; if false no compression format will be used; the default value is false.

Note: If compression is enabled with this method but the size of the content of the message is smaller than the size of compressed content, then the message will be sent uncompressed to save bandwidth and CPU cycles with the decompression on the receiver side.

function is_compressed

boolean is_compressed()

Indicate whether or not the message should be/was compressed.

Return: Return whether or not the message should be/was compressed. If the received message was compressed, the library automatically decompresses its content without any additional code.