RMQ - RabbitMQ C++ Library
Public Member Functions | List of all members
BloombergLP::rmqt::Message Class Reference

An AMQP content message. More...

#include <rmqt_message.h>

Public Member Functions

 Message (const bsl::shared_ptr< bsl::vector< uint8_t > > &rawData, const bsl::string &messageId="", const bsl::shared_ptr< rmqt::FieldTable > &headers=bsl::shared_ptr< rmqt::FieldTable >())
 RabbitMQ message constructor. By default, message will have persistent delivery-mode. More...
 
 Message (const bsl::shared_ptr< bsl::vector< uint8_t > > &rawData, const rmqt::Properties &properties)
 RabbitMQ message constructor. By default, message will have persistent delivery-mode. More...
 
 Message (const bsl::shared_ptr< const bsl::vector< uint8_t > > &rawData, const rmqt::Properties &properties)
 RabbitMQ message constructor. By default, message will have persistent delivery-mode. More...
 
const bdlb::Guid & guid () const
 Message GUID. More...
 
const bsl::string & messageId () const
 Message id.
 
const bsl::shared_ptr< rmqt::FieldTable > & headers () const
 
rmqt::Propertiesproperties ()
 
const rmqt::Propertiesproperties () const
 
const uint8_t * payload () const
 Message payload.
 
bsl::size_t payloadSize () const
 Message payload size.
 
void updateDeliveryMode (const rmqt::DeliveryMode::Value &deliveryMode)
 Update delivery-mode(Persistent or Non-persistent). Default delivery-mode is Persistent for rmqt::Message. Persistent messages will be logged to disk, if they are delivered to durable queues.
 
void updateMessagePriority (const bsl::uint8_t &priority)
 Update update-priority. Default no priority.
 
bool isPersistent () const
 Return true, if delivery-mode is persistent for the message.
 

Detailed Description

An AMQP content message.

This class represents an AMQP message that can be published to and consumed from a RabbitMQ broker.

By default all Messages are sent with Mandatory = true to ensure no message can be silently dropped if no queues are bound. Only disable this flag if you understand this will cause silently discarded messages.

Constructor & Destructor Documentation

◆ Message() [1/3]

BloombergLP::rmqt::Message::Message ( const bsl::shared_ptr< bsl::vector< uint8_t > > &  rawData,
const bsl::string &  messageId = "",
const bsl::shared_ptr< rmqt::FieldTable > &  headers = bsl::shared_ptr<rmqt::FieldTable>() 
)

RabbitMQ message constructor. By default, message will have persistent delivery-mode.

Parameters
rawDataMessage raw data
messageIdMessage ID
headersOptional message headers

◆ Message() [2/3]

BloombergLP::rmqt::Message::Message ( const bsl::shared_ptr< bsl::vector< uint8_t > > &  rawData,
const rmqt::Properties properties 
)

RabbitMQ message constructor. By default, message will have persistent delivery-mode.

Parameters
rawDataMessage raw data
propertiesMessage ID

◆ Message() [3/3]

BloombergLP::rmqt::Message::Message ( const bsl::shared_ptr< const bsl::vector< uint8_t > > &  rawData,
const rmqt::Properties properties 
)

RabbitMQ message constructor. By default, message will have persistent delivery-mode.

Parameters
rawDataMessage raw data
propertiesMessage ID

Member Function Documentation

◆ guid()

const bdlb::Guid & BloombergLP::rmqt::Message::guid ( ) const
inline

Message GUID.

Returns
A globally unique identifier of the message

The documentation for this class was generated from the following files: