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

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

Inheritance diagram for activemq::commands::SubscriptionInfo:

Public Member Functions

 SubscriptionInfo ()
 
virtual ~SubscriptionInfo ()
 
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
 
virtual SubscriptionInfocloneDataStructure () 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.
 
virtual const std::string & getClientId () const
 
virtual std::string & getClientId ()
 
virtual void setClientId (const std::string &clientId)
 
virtual const Pointer< ActiveMQDestination > & getDestination () const
 
virtual Pointer< ActiveMQDestination > & getDestination ()
 
virtual void setDestination (const Pointer< ActiveMQDestination > &destination)
 
virtual const std::string & getSelector () const
 
virtual std::string & getSelector ()
 
virtual void setSelector (const std::string &selector)
 
virtual const std::string & getSubcriptionName () const
 
virtual std::string & getSubcriptionName ()
 
virtual void setSubcriptionName (const std::string &subcriptionName)
 
virtual const Pointer< ActiveMQDestination > & getSubscribedDestination () const
 
virtual Pointer< ActiveMQDestination > & getSubscribedDestination ()
 
virtual void setSubscribedDestination (const Pointer< ActiveMQDestination > &subscribedDestination)
 
virtual bool isNoLocal () const
 
virtual void setNoLocal (bool noLocal)
 
- 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.
 

Static Public Attributes

static const unsigned char ID_SUBSCRIPTIONINFO = 55
 

Protected Attributes

std::string clientId
 
Pointer< ActiveMQDestinationdestination
 
std::string selector
 
std::string subcriptionName
 
Pointer< ActiveMQDestinationsubscribedDestination
 
bool noLocal
 

Constructor & Destructor Documentation

◆ SubscriptionInfo()

activemq::commands::SubscriptionInfo::SubscriptionInfo ( )

◆ ~SubscriptionInfo()

virtual activemq::commands::SubscriptionInfo::~SubscriptionInfo ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

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

◆ copyDataStructure()

virtual void activemq::commands::SubscriptionInfo::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()

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

◆ getClientId() [1/2]

virtual std::string & activemq::commands::SubscriptionInfo::getClientId ( )
virtual

◆ getClientId() [2/2]

virtual const std::string & activemq::commands::SubscriptionInfo::getClientId ( ) const
virtual

◆ getDataStructureType()

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

Get the DataStructure Type as defined in CommandTypes.h.

Returns
The type of the data structure

Implements activemq::commands::DataStructure.

◆ getDestination() [1/2]

virtual Pointer< ActiveMQDestination > & activemq::commands::SubscriptionInfo::getDestination ( )
virtual

◆ getDestination() [2/2]

virtual const Pointer< ActiveMQDestination > & activemq::commands::SubscriptionInfo::getDestination ( ) const
virtual

◆ getSelector() [1/2]

virtual std::string & activemq::commands::SubscriptionInfo::getSelector ( )
virtual

◆ getSelector() [2/2]

virtual const std::string & activemq::commands::SubscriptionInfo::getSelector ( ) const
virtual

◆ getSubcriptionName() [1/2]

virtual std::string & activemq::commands::SubscriptionInfo::getSubcriptionName ( )
virtual

◆ getSubcriptionName() [2/2]

virtual const std::string & activemq::commands::SubscriptionInfo::getSubcriptionName ( ) const
virtual

◆ getSubscribedDestination() [1/2]

virtual Pointer< ActiveMQDestination > & activemq::commands::SubscriptionInfo::getSubscribedDestination ( )
virtual

◆ getSubscribedDestination() [2/2]

virtual const Pointer< ActiveMQDestination > & activemq::commands::SubscriptionInfo::getSubscribedDestination ( ) const
virtual

◆ isNoLocal()

virtual bool activemq::commands::SubscriptionInfo::isNoLocal ( ) const
virtual

◆ setClientId()

virtual void activemq::commands::SubscriptionInfo::setClientId ( const std::string & clientId)
virtual

References clientId.

◆ setDestination()

virtual void activemq::commands::SubscriptionInfo::setDestination ( const Pointer< ActiveMQDestination > & destination)
virtual

References destination.

◆ setNoLocal()

virtual void activemq::commands::SubscriptionInfo::setNoLocal ( bool noLocal)
virtual

References noLocal.

◆ setSelector()

virtual void activemq::commands::SubscriptionInfo::setSelector ( const std::string & selector)
virtual

References selector.

◆ setSubcriptionName()

virtual void activemq::commands::SubscriptionInfo::setSubcriptionName ( const std::string & subcriptionName)
virtual

References subcriptionName.

◆ setSubscribedDestination()

virtual void activemq::commands::SubscriptionInfo::setSubscribedDestination ( const Pointer< ActiveMQDestination > & subscribedDestination)
virtual

References subscribedDestination.

◆ toString()

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

◆ clientId

std::string activemq::commands::SubscriptionInfo::clientId
protected

Referenced by setClientId().

◆ destination

Pointer<ActiveMQDestination> activemq::commands::SubscriptionInfo::destination
protected

Referenced by setDestination().

◆ ID_SUBSCRIPTIONINFO

const unsigned char activemq::commands::SubscriptionInfo::ID_SUBSCRIPTIONINFO = 55
static

◆ noLocal

bool activemq::commands::SubscriptionInfo::noLocal
protected

Referenced by setNoLocal().

◆ selector

std::string activemq::commands::SubscriptionInfo::selector
protected

Referenced by setSelector().

◆ subcriptionName

std::string activemq::commands::SubscriptionInfo::subcriptionName
protected

Referenced by setSubcriptionName().

◆ subscribedDestination

Pointer<ActiveMQDestination> activemq::commands::SubscriptionInfo::subscribedDestination
protected

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