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

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

Inheritance diagram for activemq::wireformat::stomp::ProducerId:

Public Types

typedef decaf::lang::PointerComparator< ProducerIdCOMPARATOR
 

Public Member Functions

 ProducerId ()
 
 ProducerId (const ProducerId &other)
 
 ProducerId (const SessionId &sessionId, long long consumerId)
 
 ProducerId (std::string producerId)
 
virtual ~ProducerId ()
 
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
 
virtual ProducerIdcloneDataStructure () 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 ProducerId &value) const
 
const Pointer< SessionId > & getParentId () const
 
void setProducerSessionKey (std::string sessionKey)
 
virtual const std::string & getConnectionId () const
 
virtual std::string & getConnectionId ()
 
virtual void setConnectionId (const std::string &connectionId)
 
virtual long long getValue () const
 
virtual void setValue (long long value)
 
virtual long long getSessionId () const
 
virtual void setSessionId (long long sessionId)
 
virtual int compareTo (const ProducerId &value) const
 
virtual bool operator== (const ProducerId &value) const
 
virtual bool operator< (const ProducerId &value) const
 
ProducerIdoperator= (const ProducerId &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< ProducerId >
virtual ~Comparable ()
 
virtual int compareTo (const ProducerId &value) const=0
 Compares this object with the specified object for order.
 
virtual bool equals (const ProducerId &value) const=0
 
virtual bool operator== (const ProducerId &value) const=0
 Compares equality between this object and the one passed.
 
virtual bool operator< (const ProducerId &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_PRODUCERID = 123
 

Protected Attributes

std::string connectionId
 
long long value
 
long long sessionId
 

Member Typedef Documentation

◆ COMPARATOR

Constructor & Destructor Documentation

◆ ProducerId() [1/4]

activemq::commands::ProducerId::ProducerId ( )

◆ ProducerId() [2/4]

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

◆ ProducerId() [3/4]

activemq::commands::ProducerId::ProducerId ( const SessionId & sessionId,
long long consumerId )

◆ ProducerId() [4/4]

activemq::commands::ProducerId::ProducerId ( std::string producerId)

◆ ~ProducerId()

virtual activemq::commands::ProducerId::~ProducerId ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

virtual ProducerId * activemq::commands::ProducerId::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::ProducerId::compareTo ( const ProducerId & value) const
virtual

◆ copyDataStructure()

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

◆ equals() [1/2]

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

◆ equals() [2/2]

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

◆ getConnectionId() [1/2]

virtual std::string & activemq::commands::ProducerId::getConnectionId ( )
virtual

◆ getConnectionId() [2/2]

virtual const std::string & activemq::commands::ProducerId::getConnectionId ( ) const
virtual

◆ getDataStructureType()

virtual unsigned char activemq::commands::ProducerId::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::ProducerId::getHashCode ( ) const

◆ getParentId()

const Pointer< SessionId > & activemq::commands::ProducerId::getParentId ( ) const

◆ getSessionId()

virtual long long activemq::commands::ProducerId::getSessionId ( ) const
virtual

◆ getValue()

virtual long long activemq::commands::ProducerId::getValue ( ) const
virtual

◆ operator<()

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

◆ operator=()

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

◆ operator==()

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

◆ setConnectionId()

virtual void activemq::commands::ProducerId::setConnectionId ( const std::string & connectionId)
virtual

◆ setProducerSessionKey()

void activemq::commands::ProducerId::setProducerSessionKey ( std::string sessionKey)

◆ setSessionId()

virtual void activemq::commands::ProducerId::setSessionId ( long long sessionId)
virtual

◆ setValue()

virtual void activemq::commands::ProducerId::setValue ( long long value)
virtual

◆ toString()

virtual std::string activemq::commands::ProducerId::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

◆ connectionId

std::string activemq::commands::ProducerId::connectionId
protected

◆ ID_PRODUCERID

const unsigned char activemq::commands::ProducerId::ID_PRODUCERID = 123
static

◆ sessionId

long long activemq::commands::ProducerId::sessionId
protected

◆ value

long long activemq::commands::ProducerId::value
protected

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