Public Types
typedef std::map< std::string, std::string >	StringMap

Public Member Functions
const StringMap &	getProperties () const

bool	hasProperty (const std::string &name) const

const std::string &	getProperty (const std::string &name) const

const void *	getData () const

std::size_t	getLength () const

std::string	getDataAsString () const

const MessageId &	getMessageId () const

const std::string &	getPartitionKey () const

bool	hasPartitionKey () const

uint64_t	getPublishTimestamp () const

uint64_t	getEventTimestamp () const

const std::string &	getTopicName () const

Friends
class	PartitionedProducerImpl

class	PartitionedConsumerImpl

class	MultiTopicsConsumerImpl

class	MessageBuilder

class	ConsumerImpl

class	ProducerImpl

class	Commands

class	BatchMessageContainer

class	BatchAcknowledgementTracker

class	PulsarWrapper

std::ostream &	operator<< (std::ostream &s, const StringMap &map)

std::ostream &	operator<< (std::ostream &s, const Message &msg)

Member Function Documentation

◆ getData()

const void* pulsar::Message::getData ( ) const

Get the content of the message

Returns: the pointer to the message payload

◆ getDataAsString()

std::string pulsar::Message::getDataAsString ( ) const

Get string representation of the message

Returns: the string representation of the message payload

◆ getEventTimestamp()

uint64_t pulsar::Message::getEventTimestamp ( ) const

Get the event timestamp associated with this message. It is set by the client producer.

◆ getLength()

std::size_t pulsar::Message::getLength ( ) const

Get the length of the message

Returns: the length of the message payload

◆ getMessageId()

const MessageId& pulsar::Message::getMessageId ( ) const

Get the unique message ID associated with this message.

The message id can be used to univocally refer to a message without having to keep the entire payload in memory.

Only messages received from the consumer will have a message id assigned.

◆ getPartitionKey()

const std::string& pulsar::Message::getPartitionKey ( ) const

Get the partition key for this message

Returns: key string that is hashed to determine message's topic partition

◆ getProperties()

const StringMap& pulsar::Message::getProperties ( ) const

Return the properties attached to the message. Properties are application defined key/value pairs that will be attached to the message

Returns: an unmodifiable view of the properties map

◆ getProperty()

const std::string& pulsar::Message::getProperty ( const std::string & name ) const

Get the value of a specific property

Parameters

name	the name of the property

Returns: the value of the property or null if the property was not defined

◆ getPublishTimestamp()

uint64_t pulsar::Message::getPublishTimestamp ( ) const

Get the UTC based timestamp in milliseconds referring to when the message was published by the client producer

◆ getTopicName()

const std::string& pulsar::Message::getTopicName ( ) const

Get the topic Name from which this message originated from

◆ hasProperty()

bool pulsar::Message::hasProperty ( const std::string & name ) const

Check whether the message has a specific property attached.