migratorydata::MigratoryDataMessage

Represent a message.

#include <client-cpp/MigratoryDataMessage.h>

Public Functions

Name
MigratoryDataMessage()
Default constructor.
MigratoryDataMessage(const MigratoryDataMessage & message)
Copy constructor.
MigratoryDataMessage(const std::string & subject, const std::string & content)
Create a MigratoryDataMessage object.
MigratoryDataMessage(const std::string & subject, const std::string & content, const std::string & closure)
Create a MigratoryDataMessage object.
MigratoryDataMessage(const std::string & subject, const std::string & content, const std::string & closure, QoS qos, bool retained, const std::string & replySubject)
Create a MigratoryDataMessage object.
std::string getSubject() const
Get the subject of the message.
std::string getContent() const
Get the content of the message.
std::string getClosure() const
Get the closure of the message.
bool isRetained() const
Indicate whether or not the message should be/was retained by the server.
std::string getReplySubject() const
Get the subject to be used to reply to this message.
QoS getQos() const
Get the QoS level of the message.
MessageType getMessageType() const
Get the MessageType of the message.
void setCompressed(bool compressed)
Set whether to compress the content of the message or not.
bool isCompressed() const
Indicate whether or not the message should be/was compressed.
std::string toString() const
Return a string representation of the message.
virtual ~MigratoryDataMessage()
Destructor.

Protected Attributes

Name
int seq
int epoch
MessageType messageType

Public Functions Documentation

function MigratoryDataMessage

MigratoryDataMessage()

Default constructor.

function MigratoryDataMessage

MigratoryDataMessage(
    const MigratoryDataMessage & message
)

Copy constructor.

Parameters:

function MigratoryDataMessage

MigratoryDataMessage(
    const std::string & subject,
    const std::string & content
)

Create a MigratoryDataMessage object.

Parameters:

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

function MigratoryDataMessage

MigratoryDataMessage(
    const std::string & subject,
    const std::string & content,
    const std::string & 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 MigratoryDataMessage

MigratoryDataMessage(
    const std::string & subject,
    const std::string & content,
    const std::string & closure,
    QoS qos,
    bool retained,
    const std::string & 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 QoS.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

std::string getSubject() const

Get the subject of the message.

Return: A string representing the subject of the message

function getContent

std::string getContent() const

Get the content of the message.

Return: A string representing the content of the message

function getClosure

std::string getClosure() const

Get the closure of the message.

Return: The closure data of the message

function isRetained

bool isRetained() const

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

std::string getReplySubject() const

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

QoS getQos() const

Get the QoS level of the message.

Return: the QoS level of the message

function getMessageType

MessageType getMessageType() const

Get the MessageType of the message.

Return: the message type of the message

function setCompressed

void setCompressed(
    bool 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 isCompressed

bool isCompressed() const

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.

function toString

std::string toString() const

Return a string representation of the message.

function ~MigratoryDataMessage

virtual ~MigratoryDataMessage()

Destructor.

Protected Attributes Documentation

variable seq

int seq;

variable epoch

int epoch;

variable messageType

MessageType messageType;

Updated on 6 November 2020 at 13:20:01 EET