activemq-cpp-3.9.5
activemq::wireformat::stomp::MessageId Class Reference

#include <src/main/activemq/commands/MessageId.h>

Inheritance diagram for activemq::wireformat::stomp::MessageId:

Public Types

typedef decaf::lang::PointerComparator< MessageIdCOMPARATOR
 

Public Member Functions

 MessageId ()
 
 MessageId (const MessageId &other)
 
 MessageId (const std::string &messageKey)
 
 MessageId (const Pointer< ProducerInfo > &producerInfo, long long producerSequenceId)
 
 MessageId (const Pointer< ProducerId > &producerId, long long producerSequenceId)
 
 MessageId (const std::string &producerId, long long producerSequenceId)
 
virtual ~MessageId ()
 
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
 
virtual MessageIdcloneDataStructure () const
 Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.
 
virtual void copyDataStructure (const DataStructure *src)
 
virtual std::string toString () const
 Returns a string containing the information for this DataStructure such as its type and value of its elements.
 
virtual bool equals (const DataStructure *value) const
 
virtual bool equals (const MessageId &value) const
 
void setValue (const std::string &key)
 
virtual const std::string & getTextView () const
 
virtual std::string & getTextView ()
 
virtual void setTextView (const std::string &textView)
 
virtual const Pointer< ProducerId > & getProducerId () const
 
virtual Pointer< ProducerId > & getProducerId ()
 
virtual void setProducerId (const Pointer< ProducerId > &producerId)
 
virtual long long getProducerSequenceId () const
 
virtual void setProducerSequenceId (long long producerSequenceId)
 
virtual long long getBrokerSequenceId () const
 
virtual void setBrokerSequenceId (long long brokerSequenceId)
 
virtual int compareTo (const MessageId &value) const
 
virtual bool operator== (const MessageId &value) const
 
virtual bool operator< (const MessageId &value) const
 
MessageIdoperator= (const MessageId &other)
 
int getHashCode () const
 
- Public Member Functions inherited from activemq::commands::BaseDataStructure
virtual ~BaseDataStructure ()
 
virtual bool isMarshalAware () const
 Determine if the class implementing this interface is really wanting to be told about marshaling.
 
virtual void beforeMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void afterMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void beforeUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void afterUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void setMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED, const std::vector< char > &data AMQCPP_UNUSED)
 
virtual std::vector< unsigned char > getMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void copyDataStructure (const DataStructure *src AMQCPP_UNUSED)
 
virtual bool equals (const DataStructure *value AMQCPP_UNUSED) const
 
- Public Member Functions inherited from activemq::commands::DataStructure
virtual ~DataStructure ()
 
virtual void copyDataStructure (const DataStructure *src)=0
 Copy the contents of the passed object into this objects members, overwriting any existing data.
 
virtual bool equals (const DataStructure *value) const =0
 Compares the DataStructure passed in to this one, and returns if they are equivalent.
 
- Public Member Functions inherited from activemq::wireformat::MarshalAware
virtual ~MarshalAware ()
 
virtual void beforeMarshal (WireFormat *wireFormat)=0
 Called before marshaling is started to prepare the object to be marshaled.
 
virtual void afterMarshal (WireFormat *wireFormat)=0
 Called after marshaling is started to cleanup the object being marshaled.
 
virtual void beforeUnmarshal (WireFormat *wireFormat)=0
 Called before unmarshaling is started to prepare the object to be unmarshaled.
 
virtual void afterUnmarshal (WireFormat *wireFormat)=0
 Called after unmarshaling is started to cleanup the object being unmarshaled.
 
virtual void setMarshaledForm (WireFormat *wireFormat, const std::vector< char > &data)=0
 Called to set the data to this object that will contain the objects marshaled form.
 
virtual std::vector< unsigned char > getMarshaledForm (WireFormat *wireFormat)=0
 Called to get the data to this object that will contain the objects marshaled form.
 
- Public Member Functions inherited from decaf::lang::Comparable< MessageId >
virtual ~Comparable ()
 
virtual int compareTo (const MessageId &value) const=0
 Compares this object with the specified object for order.
 
virtual bool equals (const MessageId &value) const=0
 
virtual bool operator== (const MessageId &value) const=0
 Compares equality between this object and the one passed.
 
virtual bool operator< (const MessageId &value) const=0
 Compares this object to another and returns true if this object is considered to be less than the one passed.
 

Static Public Attributes

static const unsigned char ID_MESSAGEID = 110
 

Protected Attributes

std::string textView
 
Pointer< ProducerIdproducerId
 
long long producerSequenceId
 
long long brokerSequenceId
 

Member Typedef Documentation

◆ COMPARATOR

Constructor & Destructor Documentation

◆ MessageId() [1/6]

activemq::commands::MessageId::MessageId ( )

◆ MessageId() [2/6]

activemq::commands::MessageId::MessageId ( const MessageId & other)

◆ MessageId() [3/6]

activemq::commands::MessageId::MessageId ( const std::string & messageKey)

◆ MessageId() [4/6]

activemq::commands::MessageId::MessageId ( const Pointer< ProducerInfo > & producerInfo,
long long producerSequenceId )

◆ MessageId() [5/6]

activemq::commands::MessageId::MessageId ( const Pointer< ProducerId > & producerId,
long long producerSequenceId )

◆ MessageId() [6/6]

activemq::commands::MessageId::MessageId ( const std::string & producerId,
long long producerSequenceId )

◆ ~MessageId()

virtual activemq::commands::MessageId::~MessageId ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

virtual MessageId * activemq::commands::MessageId::cloneDataStructure ( ) const
virtual

Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.

Returns
new copy of this object.

Implements activemq::commands::DataStructure.

◆ compareTo()

virtual int activemq::commands::MessageId::compareTo ( const MessageId & value) const
virtual

◆ copyDataStructure()

virtual void activemq::commands::MessageId::copyDataStructure ( const DataStructure * src)
virtual

◆ equals() [1/2]

virtual bool activemq::commands::MessageId::equals ( const DataStructure * value) const
virtual

◆ equals() [2/2]

virtual bool activemq::commands::MessageId::equals ( const MessageId & value) const
virtual

◆ getBrokerSequenceId()

virtual long long activemq::commands::MessageId::getBrokerSequenceId ( ) const
virtual

◆ getDataStructureType()

virtual unsigned char activemq::commands::MessageId::getDataStructureType ( ) const
virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns
The type of the data structure

Implements activemq::commands::DataStructure.

◆ getHashCode()

int activemq::commands::MessageId::getHashCode ( ) const

◆ getProducerId() [1/2]

virtual Pointer< ProducerId > & activemq::commands::MessageId::getProducerId ( )
virtual

◆ getProducerId() [2/2]

virtual const Pointer< ProducerId > & activemq::commands::MessageId::getProducerId ( ) const
virtual

◆ getProducerSequenceId()

virtual long long activemq::commands::MessageId::getProducerSequenceId ( ) const
virtual

◆ getTextView() [1/2]

virtual std::string & activemq::commands::MessageId::getTextView ( )
virtual

◆ getTextView() [2/2]

virtual const std::string & activemq::commands::MessageId::getTextView ( ) const
virtual

◆ operator<()

virtual bool activemq::commands::MessageId::operator< ( const MessageId & value) const
virtual

◆ operator=()

MessageId & activemq::commands::MessageId::operator= ( const MessageId & other)

◆ operator==()

virtual bool activemq::commands::MessageId::operator== ( const MessageId & value) const
virtual

◆ setBrokerSequenceId()

virtual void activemq::commands::MessageId::setBrokerSequenceId ( long long brokerSequenceId)
virtual

◆ setProducerId()

virtual void activemq::commands::MessageId::setProducerId ( const Pointer< ProducerId > & producerId)
virtual

◆ setProducerSequenceId()

virtual void activemq::commands::MessageId::setProducerSequenceId ( long long producerSequenceId)
virtual

◆ setTextView()

virtual void activemq::commands::MessageId::setTextView ( const std::string & textView)
virtual

◆ setValue()

void activemq::commands::MessageId::setValue ( const std::string & key)

◆ toString()

virtual std::string activemq::commands::MessageId::toString ( ) const
virtual

Returns a string containing the information for this DataStructure such as its type and value of its elements.

Returns
formatted string useful for debugging.

Reimplemented from activemq::commands::BaseDataStructure.

Field Documentation

◆ brokerSequenceId

long long activemq::commands::MessageId::brokerSequenceId
protected

◆ ID_MESSAGEID

const unsigned char activemq::commands::MessageId::ID_MESSAGEID = 110
static

◆ producerId

Pointer<ProducerId> activemq::commands::MessageId::producerId
protected

◆ producerSequenceId

long long activemq::commands::MessageId::producerSequenceId
protected

◆ textView

std::string activemq::commands::MessageId::textView
protected

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