activemq-cpp-3.6.0
activemq::commands::ConsumerId Class Reference

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

Inheritance diagram for activemq::commands::ConsumerId:

Public Types

typedef
decaf::lang::PointerComparator
< ConsumerId
COMPARATOR

Public Member Functions

 ConsumerId ()
 ConsumerId (const ConsumerId &other)
 ConsumerId (const SessionId &sessionId, long long consumerIdd)
virtual ~ConsumerId ()
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
virtual ConsumerIdcloneDataStructure () 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)
 Copy the contents of the passed object into this objects members, overwriting any existing data.
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
 Compares the DataStructure passed in to this one, and returns if they are equivalent.
const Pointer< SessionId > & getParentId () const
virtual const std::string & getConnectionId () const
virtual std::string & getConnectionId ()
virtual void setConnectionId (const std::string &connectionId)
virtual long long getSessionId () const
virtual void setSessionId (long long sessionId)
virtual long long getValue () const
virtual void setValue (long long value)
virtual int compareTo (const ConsumerId &value) const
virtual bool equals (const ConsumerId &value) const
virtual bool operator== (const ConsumerId &value) const
virtual bool operator< (const ConsumerId &value) const
ConsumerIdoperator= (const ConsumerId &other)
- 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 ()
- 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< ConsumerId >
virtual ~Comparable ()
virtual int compareTo (const ConsumerId &value) const =0
 Compares this object with the specified object for order.
virtual bool equals (const ConsumerId &value) const =0
virtual bool operator== (const ConsumerId &value) const =0
 Compares equality between this object and the one passed.
virtual bool operator< (const ConsumerId &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_CONSUMERID = 122

Protected Attributes

std::string connectionId
long long sessionId
long long value

Member Typedef Documentation

Constructor & Destructor Documentation

activemq::commands::ConsumerId::ConsumerId ( )
activemq::commands::ConsumerId::ConsumerId ( const ConsumerId other)
activemq::commands::ConsumerId::ConsumerId ( const SessionId sessionId,
long long  consumerIdd 
)
virtual activemq::commands::ConsumerId::~ConsumerId ( )
virtual

Member Function Documentation

virtual ConsumerId* activemq::commands::ConsumerId::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.

virtual int activemq::commands::ConsumerId::compareTo ( const ConsumerId value) const
virtual
virtual void activemq::commands::ConsumerId::copyDataStructure ( const DataStructure src)
virtual

Copy the contents of the passed object into this objects members, overwriting any existing data.

Returns
src - Source Object

Implements activemq::commands::DataStructure.

virtual bool activemq::commands::ConsumerId::equals ( const DataStructure value) const
virtual

Compares the DataStructure passed in to this one, and returns if they are equivalent.

Equivalent here means that they are of the same type, and that each element of the objects are the same.

Returns
true if DataStructure's are Equal.

Implements activemq::commands::DataStructure.

virtual bool activemq::commands::ConsumerId::equals ( const ConsumerId value) const
virtual
virtual const std::string& activemq::commands::ConsumerId::getConnectionId ( ) const
virtual
virtual std::string& activemq::commands::ConsumerId::getConnectionId ( )
virtual
virtual unsigned char activemq::commands::ConsumerId::getDataStructureType ( ) const
virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns
The type of the data structure

Implements activemq::commands::DataStructure.

const Pointer<SessionId>& activemq::commands::ConsumerId::getParentId ( ) const
virtual long long activemq::commands::ConsumerId::getSessionId ( ) const
virtual
virtual long long activemq::commands::ConsumerId::getValue ( ) const
virtual
virtual bool activemq::commands::ConsumerId::operator< ( const ConsumerId value) const
virtual
ConsumerId& activemq::commands::ConsumerId::operator= ( const ConsumerId other)
virtual bool activemq::commands::ConsumerId::operator== ( const ConsumerId value) const
virtual
virtual void activemq::commands::ConsumerId::setConnectionId ( const std::string &  connectionId)
virtual
virtual void activemq::commands::ConsumerId::setSessionId ( long long  sessionId)
virtual
virtual void activemq::commands::ConsumerId::setValue ( long long  value)
virtual
virtual std::string activemq::commands::ConsumerId::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

std::string activemq::commands::ConsumerId::connectionId
protected
const unsigned char activemq::commands::ConsumerId::ID_CONSUMERID = 122
static
long long activemq::commands::ConsumerId::sessionId
protected
long long activemq::commands::ConsumerId::value
protected

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