MigratoryDataMessage

Represent a message.

#include <client-ios/MigratoryDataMessage.h>

Inherits from NSObject

Public Classes

Public Functions

Public Functions Documentation

function init:content:

virtual id init:content:(
    NSString * subject,
    NSString * content
)

Create a MigratoryDataMessage object.

Parameters:

• subject The subject of the message
• content The content of the message

function init:content:closure:

virtual id init:content:closure:(
    NSString * subject,
    NSString * content,
    NSString * closure
)

Create a MigratoryDataMessage object.

Parameters:

• subject The subject of the message
• content The content of the message
• closure The closure of the message (OPTIONAL)

function init:content:closure:qos:retained:

virtual id init:content:closure:qos:retained:(
    NSString * subject,
    NSString * content,
    NSString * closure,
    MigratoryDataQoS qos,
    bool retained
)

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 MigratoryDataQoS.GUARANTEED (OPTIONAL)
• retained indicate whether or not the message should be/was retained by the server; the default is true (OPTIONAL)

function init:content:closure:qos:retained:replySubject:

virtual id init:content:closure:qos:retained:replySubject:(
    NSString * subject,
    NSString * content,
    NSString * closure,
    MigratoryDataQoS qos,
    bool retained,
    NSString * replySubject
)

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 MigratoryDataQoS.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 getSubject

virtual NSString * getSubject()

Get the subject of the message.

Return: A string representing the subject of the message

function getContent

virtual NSString * getContent()

Get the content of the message.

Return: A string representing the content of the message

function getClosure

virtual NSString * getClosure()

Get the closure of the message.

Return: The closure data of the message

function isRetained

virtual bool isRetained()

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 getReplySubject

virtual NSString * getReplySubject()

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 getQos

virtual MigratoryDataQoS getQos()

Get the QoS level of the message.

Return: the QoS level of the message

function getMessageType

virtual MigratoryDataMessageType getMessageType()

Get the MessageType of the message.

Return: the message type of the message

function setCompressed

virtual void setCompressed(
    bool compressed
)

Sets whether the content of the message should be compressed.

If true, compression is enabled using the default algorithm ZLIB_BASE64, unless compression has already been explicitly enabled via setCompressionAlgorithm() with ZLIB_BINARY, in which case the existing algorithm – which is more compact – is preserved.

If false, compression is disabled (i.e., compression algorithm is set to NONE).

Note: If compression is enabled but the resulting compressed content is larger than the original, the message will be sent uncompressed to optimize bandwidth and avoid unnecessary decompression on the subscriber side.

Default behavior: If neither this method nor setCompressionAlgorithm() is called, compression is disabled by default (i.e. the compression algorithm is set to NONE).

Parameters:

• compressed — true to enable compression using ZLIB_BASE64 unless already enabled with ZLIB_BINARY; false to disable.

function setCompressionAlgorithm

virtual void setCompressionAlgorithm(
    MigratoryDataCompressionAlgorithm algorithm
)

Sets the algorithm that determines whether and how the message is compressed.

Supported algorithms:

• NONE — disables compression
• ZLIB_BASE64 — enables compression with base64 encoding
• ZLIB_BINARY — enables binary compression (most compact)

This method overrides any previously configured compression setting, including one set by setCompressed().

Note: If compression results in a larger payload, the message will be sent uncompressed.

Default behavior: If neither this method nor setCompressed() is called, compression is disabled by default (i.e. the compression algorithm is set to NONE).

Parameters:

• algorithm — the MigratoryDataCompressionAlgorithm to apply.

function getCompressionAlgorithm

virtual MigratoryDataCompressionAlgorithm getCompressionAlgorithm() const

Returns the compression algorithm currently set for the message.

The returned value reflects the current compression setting of the message, whether it was set via setCompressed() and/or setCompressionAlgorithm().

Return: the MigratoryDataCompressionAlgorithm set for this message.

function isCompressed

virtual bool isCompressed() const

Indicates whether the message should be or was compressed.

On the publisher side, this indicates whether compression should be applied before sending the message. On the subscriber side, this indicates whether the message was received in compressed form. In both cases, if compression is involved, the library automatically handles compression and decompression.

Return: true if compression is enabled on the publisher side or the message was received compressed on the subscriber side; false otherwise.

Enum CompressionAlgorithm

Represents the available compression algorithms for message payloads.

typedef NS_ENUM(NSInteger, MigratoryDataCompressionAlgorithm) {
    NONE = 0, // No compression applied
    ZLIB_BASE64, // ZLIB + Base64 encoding
    ZLIB_BINARY // ZLIB + raw binary
};

Enum Values:

• NONE — No compression applied.
• ZLIB_BASE64 — Compression using ZLIB with base64 encoding for UTF-8 transport.
• ZLIB_BINARY — Compression using ZLIB with raw binary output for max efficiency.

Each enum constant is associated with an internal numeric code.