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

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

Inheritance diagram for activemq::commands::ConsumerInfo:

Public Member Functions

 ConsumerInfo ()
 
virtual ~ConsumerInfo ()
 
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
 
virtual ConsumerInfocloneDataStructure () 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.
 
Pointer< RemoveInfocreateRemoveCommand () const
 
int getCurrentPrefetchSize () const
 
void setCurrentPrefetchSize (int currentPrefetchSize)
 
virtual const Pointer< ConsumerId > & getConsumerId () const
 
virtual Pointer< ConsumerId > & getConsumerId ()
 
virtual void setConsumerId (const Pointer< ConsumerId > &consumerId)
 
virtual bool isBrowser () const
 
virtual void setBrowser (bool browser)
 
virtual const Pointer< ActiveMQDestination > & getDestination () const
 
virtual Pointer< ActiveMQDestination > & getDestination ()
 
virtual void setDestination (const Pointer< ActiveMQDestination > &destination)
 
virtual int getPrefetchSize () const
 
virtual void setPrefetchSize (int prefetchSize)
 
virtual int getMaximumPendingMessageLimit () const
 
virtual void setMaximumPendingMessageLimit (int maximumPendingMessageLimit)
 
virtual bool isDispatchAsync () const
 
virtual void setDispatchAsync (bool dispatchAsync)
 
virtual const std::string & getSelector () const
 
virtual std::string & getSelector ()
 
virtual void setSelector (const std::string &selector)
 
virtual const std::string & getClientId () const
 
virtual std::string & getClientId ()
 
virtual void setClientId (const std::string &clientId)
 
virtual const std::string & getSubscriptionName () const
 
virtual std::string & getSubscriptionName ()
 
virtual void setSubscriptionName (const std::string &subscriptionName)
 
virtual bool isNoLocal () const
 
virtual void setNoLocal (bool noLocal)
 
virtual bool isExclusive () const
 
virtual void setExclusive (bool exclusive)
 
virtual bool isRetroactive () const
 
virtual void setRetroactive (bool retroactive)
 
virtual unsigned char getPriority () const
 
virtual void setPriority (unsigned char priority)
 
virtual const std::vector< decaf::lang::Pointer< BrokerId > > & getBrokerPath () const
 
virtual std::vector< decaf::lang::Pointer< BrokerId > > & getBrokerPath ()
 
virtual void setBrokerPath (const std::vector< decaf::lang::Pointer< BrokerId > > &brokerPath)
 
virtual const Pointer< BooleanExpression > & getAdditionalPredicate () const
 
virtual Pointer< BooleanExpression > & getAdditionalPredicate ()
 
virtual void setAdditionalPredicate (const Pointer< BooleanExpression > &additionalPredicate)
 
virtual bool isNetworkSubscription () const
 
virtual void setNetworkSubscription (bool networkSubscription)
 
virtual bool isOptimizedAcknowledge () const
 
virtual void setOptimizedAcknowledge (bool optimizedAcknowledge)
 
virtual bool isNoRangeAcks () const
 
virtual void setNoRangeAcks (bool noRangeAcks)
 
virtual const std::vector< decaf::lang::Pointer< ConsumerId > > & getNetworkConsumerPath () const
 
virtual std::vector< decaf::lang::Pointer< ConsumerId > > & getNetworkConsumerPath ()
 
virtual void setNetworkConsumerPath (const std::vector< decaf::lang::Pointer< ConsumerId > > &networkConsumerPath)
 
virtual bool isConsumerInfo () const
 
virtual Pointer< Commandvisit (activemq::state::CommandVisitor *visitor)
 Allows a Visitor to visit this command and return a response to the command based on the command type being visited.
 
- Public Member Functions inherited from activemq::commands::BaseCommand
 BaseCommand ()
 
virtual ~BaseCommand ()
 
virtual void setCommandId (int id)
 Sets the Command Id of this Message.
 
virtual int getCommandId () const
 Gets the Command Id of this Message.
 
virtual void setResponseRequired (const bool required)
 Set if this Message requires a Response.
 
virtual bool isResponseRequired () const
 Is a Response required for this Command.
 
virtual bool isBrokerInfo () const
 
virtual bool isControlCommand () const
 
virtual bool isConnectionControl () const
 
virtual bool isConnectionError () const
 
virtual bool isConnectionInfo () const
 
virtual bool isConsumerControl () const
 
virtual bool isDestinationInfo () const
 
virtual bool isFlushCommand () const
 
virtual bool isMessage () const
 
virtual bool isMessageAck () const
 
virtual bool isMessagePull () const
 
virtual bool isKeepAliveInfo () const
 
virtual bool isMessageDispatch () const
 
virtual bool isMessageDispatchNotification () const
 
virtual bool isProducerAck () const
 
virtual bool isProducerInfo () const
 
virtual bool isResponse () const
 
virtual bool isRemoveInfo () const
 
virtual bool isRemoveSubscriptionInfo () const
 
virtual bool isReplayCommand () const
 
virtual bool isSessionInfo () const
 
virtual bool isShutdownInfo () const
 
virtual bool isTransactionInfo () const
 
virtual bool isWireFormatInfo () const
 
- Public Member Functions inherited from activemq::commands::Command
virtual ~Command ()
 
- 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_CONSUMERINFO = 5
 

Protected Attributes

Pointer< ConsumerIdconsumerId
 
bool browser
 
Pointer< ActiveMQDestinationdestination
 
int prefetchSize
 
int maximumPendingMessageLimit
 
bool dispatchAsync
 
std::string selector
 
std::string clientId
 
std::string subscriptionName
 
bool noLocal
 
bool exclusive
 
bool retroactive
 
unsigned char priority
 
std::vector< decaf::lang::Pointer< BrokerId > > brokerPath
 
Pointer< BooleanExpressionadditionalPredicate
 
bool networkSubscription
 
bool optimizedAcknowledge
 
bool noRangeAcks
 
std::vector< decaf::lang::Pointer< ConsumerId > > networkConsumerPath
 

Constructor & Destructor Documentation

◆ ConsumerInfo()

activemq::commands::ConsumerInfo::ConsumerInfo ( )

◆ ~ConsumerInfo()

virtual activemq::commands::ConsumerInfo::~ConsumerInfo ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

virtual ConsumerInfo * activemq::commands::ConsumerInfo::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::ConsumerInfo::copyDataStructure ( const DataStructure * src)
virtual

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

Returns
src - Source Object

Reimplemented from activemq::commands::BaseCommand.

◆ createRemoveCommand()

Pointer< RemoveInfo > activemq::commands::ConsumerInfo::createRemoveCommand ( ) const

◆ equals()

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

Reimplemented from activemq::commands::BaseCommand.

◆ getAdditionalPredicate() [1/2]

virtual Pointer< BooleanExpression > & activemq::commands::ConsumerInfo::getAdditionalPredicate ( )
virtual

◆ getAdditionalPredicate() [2/2]

virtual const Pointer< BooleanExpression > & activemq::commands::ConsumerInfo::getAdditionalPredicate ( ) const
virtual

◆ getBrokerPath() [1/2]

virtual std::vector< decaf::lang::Pointer< BrokerId > > & activemq::commands::ConsumerInfo::getBrokerPath ( )
virtual

◆ getBrokerPath() [2/2]

virtual const std::vector< decaf::lang::Pointer< BrokerId > > & activemq::commands::ConsumerInfo::getBrokerPath ( ) const
virtual

◆ getClientId() [1/2]

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

◆ getClientId() [2/2]

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

◆ getConsumerId() [1/2]

virtual Pointer< ConsumerId > & activemq::commands::ConsumerInfo::getConsumerId ( )
virtual

◆ getConsumerId() [2/2]

virtual const Pointer< ConsumerId > & activemq::commands::ConsumerInfo::getConsumerId ( ) const
virtual

◆ getCurrentPrefetchSize()

int activemq::commands::ConsumerInfo::getCurrentPrefetchSize ( ) const
inline

◆ getDataStructureType()

virtual unsigned char activemq::commands::ConsumerInfo::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::ConsumerInfo::getDestination ( )
virtual

◆ getDestination() [2/2]

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

◆ getMaximumPendingMessageLimit()

virtual int activemq::commands::ConsumerInfo::getMaximumPendingMessageLimit ( ) const
virtual

◆ getNetworkConsumerPath() [1/2]

virtual std::vector< decaf::lang::Pointer< ConsumerId > > & activemq::commands::ConsumerInfo::getNetworkConsumerPath ( )
virtual

◆ getNetworkConsumerPath() [2/2]

virtual const std::vector< decaf::lang::Pointer< ConsumerId > > & activemq::commands::ConsumerInfo::getNetworkConsumerPath ( ) const
virtual

◆ getPrefetchSize()

virtual int activemq::commands::ConsumerInfo::getPrefetchSize ( ) const
virtual

◆ getPriority()

virtual unsigned char activemq::commands::ConsumerInfo::getPriority ( ) const
virtual

◆ getSelector() [1/2]

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

◆ getSelector() [2/2]

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

◆ getSubscriptionName() [1/2]

virtual std::string & activemq::commands::ConsumerInfo::getSubscriptionName ( )
virtual

◆ getSubscriptionName() [2/2]

virtual const std::string & activemq::commands::ConsumerInfo::getSubscriptionName ( ) const
virtual

◆ isBrowser()

virtual bool activemq::commands::ConsumerInfo::isBrowser ( ) const
virtual

◆ isConsumerInfo()

virtual bool activemq::commands::ConsumerInfo::isConsumerInfo ( ) const
inlinevirtual
Returns
an answer of true to the isConsumerInfo() query.

Reimplemented from activemq::commands::BaseCommand.

◆ isDispatchAsync()

virtual bool activemq::commands::ConsumerInfo::isDispatchAsync ( ) const
virtual

◆ isExclusive()

virtual bool activemq::commands::ConsumerInfo::isExclusive ( ) const
virtual

◆ isNetworkSubscription()

virtual bool activemq::commands::ConsumerInfo::isNetworkSubscription ( ) const
virtual

◆ isNoLocal()

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

◆ isNoRangeAcks()

virtual bool activemq::commands::ConsumerInfo::isNoRangeAcks ( ) const
virtual

◆ isOptimizedAcknowledge()

virtual bool activemq::commands::ConsumerInfo::isOptimizedAcknowledge ( ) const
virtual

◆ isRetroactive()

virtual bool activemq::commands::ConsumerInfo::isRetroactive ( ) const
virtual

◆ setAdditionalPredicate()

virtual void activemq::commands::ConsumerInfo::setAdditionalPredicate ( const Pointer< BooleanExpression > & additionalPredicate)
virtual

References additionalPredicate.

◆ setBrokerPath()

virtual void activemq::commands::ConsumerInfo::setBrokerPath ( const std::vector< decaf::lang::Pointer< BrokerId > > & brokerPath)
virtual

References brokerPath.

◆ setBrowser()

virtual void activemq::commands::ConsumerInfo::setBrowser ( bool browser)
virtual

References browser.

◆ setClientId()

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

References clientId.

◆ setConsumerId()

virtual void activemq::commands::ConsumerInfo::setConsumerId ( const Pointer< ConsumerId > & consumerId)
virtual

References consumerId.

◆ setCurrentPrefetchSize()

void activemq::commands::ConsumerInfo::setCurrentPrefetchSize ( int currentPrefetchSize)
inline

◆ setDestination()

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

References destination.

◆ setDispatchAsync()

virtual void activemq::commands::ConsumerInfo::setDispatchAsync ( bool dispatchAsync)
virtual

References dispatchAsync.

◆ setExclusive()

virtual void activemq::commands::ConsumerInfo::setExclusive ( bool exclusive)
virtual

References exclusive.

◆ setMaximumPendingMessageLimit()

virtual void activemq::commands::ConsumerInfo::setMaximumPendingMessageLimit ( int maximumPendingMessageLimit)
virtual

◆ setNetworkConsumerPath()

virtual void activemq::commands::ConsumerInfo::setNetworkConsumerPath ( const std::vector< decaf::lang::Pointer< ConsumerId > > & networkConsumerPath)
virtual

References networkConsumerPath.

◆ setNetworkSubscription()

virtual void activemq::commands::ConsumerInfo::setNetworkSubscription ( bool networkSubscription)
virtual

References networkSubscription.

◆ setNoLocal()

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

References noLocal.

◆ setNoRangeAcks()

virtual void activemq::commands::ConsumerInfo::setNoRangeAcks ( bool noRangeAcks)
virtual

References noRangeAcks.

◆ setOptimizedAcknowledge()

virtual void activemq::commands::ConsumerInfo::setOptimizedAcknowledge ( bool optimizedAcknowledge)
virtual

References optimizedAcknowledge.

◆ setPrefetchSize()

virtual void activemq::commands::ConsumerInfo::setPrefetchSize ( int prefetchSize)
virtual

References prefetchSize.

◆ setPriority()

virtual void activemq::commands::ConsumerInfo::setPriority ( unsigned char priority)
virtual

References priority.

◆ setRetroactive()

virtual void activemq::commands::ConsumerInfo::setRetroactive ( bool retroactive)
virtual

References retroactive.

◆ setSelector()

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

References selector.

◆ setSubscriptionName()

virtual void activemq::commands::ConsumerInfo::setSubscriptionName ( const std::string & subscriptionName)
virtual

References subscriptionName.

◆ toString()

virtual std::string activemq::commands::ConsumerInfo::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::BaseCommand.

◆ visit()

virtual Pointer< Command > activemq::commands::ConsumerInfo::visit ( activemq::state::CommandVisitor * visitor)
virtual

Allows a Visitor to visit this command and return a response to the command based on the command type being visited.

The command will call the proper processXXX method in the visitor.

Returns
a Response to the visitor being called or NULL if no response.

Implements activemq::commands::Command.

Field Documentation

◆ additionalPredicate

Pointer<BooleanExpression> activemq::commands::ConsumerInfo::additionalPredicate
protected

Referenced by setAdditionalPredicate().

◆ brokerPath

std::vector< decaf::lang::Pointer<BrokerId> > activemq::commands::ConsumerInfo::brokerPath
protected

Referenced by setBrokerPath().

◆ browser

bool activemq::commands::ConsumerInfo::browser
protected

Referenced by setBrowser().

◆ clientId

std::string activemq::commands::ConsumerInfo::clientId
protected

Referenced by setClientId().

◆ consumerId

Pointer<ConsumerId> activemq::commands::ConsumerInfo::consumerId
protected

Referenced by setConsumerId().

◆ destination

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

Referenced by setDestination().

◆ dispatchAsync

bool activemq::commands::ConsumerInfo::dispatchAsync
protected

Referenced by setDispatchAsync().

◆ exclusive

bool activemq::commands::ConsumerInfo::exclusive
protected

Referenced by setExclusive().

◆ ID_CONSUMERINFO

const unsigned char activemq::commands::ConsumerInfo::ID_CONSUMERINFO = 5
static

◆ maximumPendingMessageLimit

int activemq::commands::ConsumerInfo::maximumPendingMessageLimit
protected

◆ networkConsumerPath

std::vector< decaf::lang::Pointer<ConsumerId> > activemq::commands::ConsumerInfo::networkConsumerPath
protected

Referenced by setNetworkConsumerPath().

◆ networkSubscription

bool activemq::commands::ConsumerInfo::networkSubscription
protected

Referenced by setNetworkSubscription().

◆ noLocal

bool activemq::commands::ConsumerInfo::noLocal
protected

Referenced by setNoLocal().

◆ noRangeAcks

bool activemq::commands::ConsumerInfo::noRangeAcks
protected

Referenced by setNoRangeAcks().

◆ optimizedAcknowledge

bool activemq::commands::ConsumerInfo::optimizedAcknowledge
protected

Referenced by setOptimizedAcknowledge().

◆ prefetchSize

int activemq::commands::ConsumerInfo::prefetchSize
protected

Referenced by setPrefetchSize().

◆ priority

unsigned char activemq::commands::ConsumerInfo::priority
protected

Referenced by setPriority().

◆ retroactive

bool activemq::commands::ConsumerInfo::retroactive
protected

Referenced by setRetroactive().

◆ selector

std::string activemq::commands::ConsumerInfo::selector
protected

Referenced by setSelector().

◆ subscriptionName

std::string activemq::commands::ConsumerInfo::subscriptionName
protected

Referenced by setSubscriptionName().


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