activemq-cpp-3.9.5
activemq::commands::SessionId Class Reference

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

Inheritance diagram for activemq::commands::SessionId:

Public Types

typedef decaf::lang::PointerComparator< SessionIdCOMPARATOR
 

Public Member Functions

 SessionId ()
 
 SessionId (const SessionId &other)
 
 SessionId (const ConnectionId *connectionId, long long sessionId)
 
 SessionId (const ProducerId *producerId)
 
 SessionId (const ConsumerId *consumerId)
 
virtual ~SessionId ()
 
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
 
virtual SessionIdcloneDataStructure () 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< ConnectionId > & getParentId () const
 
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 int compareTo (const SessionId &value) const
 
virtual bool equals (const SessionId &value) const
 
virtual bool operator== (const SessionId &value) const
 
virtual bool operator< (const SessionId &value) const
 
SessionIdoperator= (const SessionId &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 ()
 
- 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< SessionId >
virtual ~Comparable ()
 
virtual int compareTo (const SessionId &value) const=0
 Compares this object with the specified object for order.
 
virtual bool equals (const SessionId &value) const=0
 
virtual bool operator== (const SessionId &value) const=0
 Compares equality between this object and the one passed.
 
virtual bool operator< (const SessionId &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_SESSIONID = 121
 

Protected Attributes

std::string connectionId
 
long long value
 

Member Typedef Documentation

◆ COMPARATOR

Constructor & Destructor Documentation

◆ SessionId() [1/5]

activemq::commands::SessionId::SessionId ( )

◆ SessionId() [2/5]

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

References SessionId().

◆ SessionId() [3/5]

activemq::commands::SessionId::SessionId ( const ConnectionId * connectionId,
long long sessionId )

References connectionId.

◆ SessionId() [4/5]

activemq::commands::SessionId::SessionId ( const ProducerId * producerId)

◆ SessionId() [5/5]

activemq::commands::SessionId::SessionId ( const ConsumerId * consumerId)

◆ ~SessionId()

virtual activemq::commands::SessionId::~SessionId ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

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

References SessionId().

◆ compareTo()

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

References SessionId(), and value.

◆ copyDataStructure()

virtual void activemq::commands::SessionId::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.

◆ equals() [1/2]

virtual bool activemq::commands::SessionId::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.

References value.

◆ equals() [2/2]

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

References SessionId(), and value.

◆ getConnectionId() [1/2]

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

◆ getConnectionId() [2/2]

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

◆ getDataStructureType()

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

◆ getParentId()

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

◆ getValue()

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

◆ operator<()

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

References SessionId(), and value.

◆ operator=()

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

References SessionId().

◆ operator==()

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

References SessionId(), and value.

◆ setConnectionId()

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

References connectionId.

◆ setValue()

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

References value.

◆ toString()

virtual std::string activemq::commands::SessionId::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::SessionId::connectionId
protected

Referenced by SessionId(), and setConnectionId().

◆ ID_SESSIONID

const unsigned char activemq::commands::SessionId::ID_SESSIONID = 121
static

◆ value

long long activemq::commands::SessionId::value
protected

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