MigratoryDataMessage

Represent a message.

Public Classes

Public Functions

Public Functions Documentation

function MigratoryDataMessage

MigratoryDataMessage(
    String subject,
    String content,
    QoS qos,
    boolean retained
)

Create a MigratoryDataMessage object.

Parameters:

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

Exceptions:

• MigratoryDataException An expection with the E_INVALID_SUBJECT code

function getSubject

String getSubject()

Get the subject of the message.

Return: A string representing the subject of the message

function getContent

String getContent()

Get the content of the message.

Return: A string representing the content of the message

function getQos

QoS getQos()

Get the QoS level of the message.

Return: the QoS level of the message

function isRetained

boolean 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 setCompressed

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

void setCompressionAlgorithm(CompressionAlgorithm 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 CompressionAlgorithm to apply.

function getCompressionAlgorithm

CompressionAlgorithm getCompressionAlgorithm()

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 CompressionAlgorithm set for this message.

function isCompressed

bool isCompressed()

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.

class CompressionAlgorithm {
   const NONE = 0;         // No compression applied
   const ZLIB_BASE64 = 1;  // ZLIB + Base64 encoding
   const ZLIB_BINARY = 2;  // 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.