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 ConsumerInfo *	cloneDataStructure () 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< RemoveInfo >	createRemoveCommand () const
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 &	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< Command >	visit (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.
Static Public Attributes
static const unsigned char	ID_CONSUMERINFO = 5
Protected Attributes
Pointer< ConsumerId >	consumerId
bool	browser
Pointer< ActiveMQDestination >	destination
int	prefetchSize
int	maximumPendingMessageLimit
bool	dispatchAsync
std::string	selector
std::string	subscriptionName
bool	noLocal
bool	exclusive
bool	retroactive
unsigned char	priority
std::vector < decaf::lang::Pointer < BrokerId > >	brokerPath
Pointer< BooleanExpression >	additionalPredicate
bool	networkSubscription
bool	optimizedAcknowledge
bool	noRangeAcks
std::vector < decaf::lang::Pointer < ConsumerId > >	networkConsumerPath

---

Constructor & Destructor Documentation

activemq::commands::ConsumerInfo::ConsumerInfo

(

)

virtual activemq::commands::ConsumerInfo::~ConsumerInfo

(

)

[virtual]

---

Member Function Documentation

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.

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.

Pointer<RemoveInfo> activemq::commands::ConsumerInfo::createRemoveCommand

(

)

const

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.

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

(

)

const [virtual]

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

(

)

[virtual]

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

(

)

const [virtual]

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

(

)

[virtual]

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

(

)

[virtual]

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

(

)

const [virtual]

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.

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

(

)

const [virtual]

virtual Pointer<ActiveMQDestination>& activemq::commands::ConsumerInfo::getDestination

(

)

[virtual]

virtual int activemq::commands::ConsumerInfo::getMaximumPendingMessageLimit

(

)

const [virtual]

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

(

)

const [virtual]

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

(

)

[virtual]

virtual int activemq::commands::ConsumerInfo::getPrefetchSize

(

)

const [virtual]

virtual unsigned char activemq::commands::ConsumerInfo::getPriority

(

)

const [virtual]

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

(

)

const [virtual]

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

(

)

[virtual]

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

(

)

const [virtual]

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

(

)

[virtual]

virtual bool activemq::commands::ConsumerInfo::isBrowser

(

)

const [virtual]

virtual bool activemq::commands::ConsumerInfo::isConsumerInfo

(

)

const [inline, virtual]

Returns:

an answer of true to the isConsumerInfo() query.

Reimplemented from activemq::commands::BaseCommand.

virtual bool activemq::commands::ConsumerInfo::isDispatchAsync

(

)

const [virtual]

virtual bool activemq::commands::ConsumerInfo::isExclusive

(

)

const [virtual]

virtual bool activemq::commands::ConsumerInfo::isNetworkSubscription

(

)

const [virtual]

virtual bool activemq::commands::ConsumerInfo::isNoLocal

(

)

const [virtual]

virtual bool activemq::commands::ConsumerInfo::isNoRangeAcks

(

)

const [virtual]

virtual bool activemq::commands::ConsumerInfo::isOptimizedAcknowledge

(

)

const [virtual]

virtual bool activemq::commands::ConsumerInfo::isRetroactive

(

)

const [virtual]

virtual void activemq::commands::ConsumerInfo::setAdditionalPredicate

(

const Pointer< BooleanExpression > &

additionalPredicate

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setBrokerPath

(

const std::vector< decaf::lang::Pointer< BrokerId > > &

brokerPath

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setBrowser

(

bool

browser

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setConsumerId

(

const Pointer< ConsumerId > &

consumerId

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setDestination

(

const Pointer< ActiveMQDestination > &

destination

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setDispatchAsync

(

bool

dispatchAsync

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setExclusive

(

bool

exclusive

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setMaximumPendingMessageLimit

(

int

maximumPendingMessageLimit

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setNetworkConsumerPath

(

const std::vector< decaf::lang::Pointer< ConsumerId > > &

networkConsumerPath

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setNetworkSubscription

(

bool

networkSubscription

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setNoLocal

(

bool

noLocal

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setNoRangeAcks

(

bool

noRangeAcks

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setOptimizedAcknowledge

(

bool

optimizedAcknowledge

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setPrefetchSize

(

int

prefetchSize

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setPriority

(

unsigned char

priority

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setRetroactive

(

bool

retroactive

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setSelector

(

const std::string &

selector

)

[virtual]

virtual void activemq::commands::ConsumerInfo::setSubscriptionName

(

const std::string &

subscriptionName

)

[virtual]

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.

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

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

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

bool activemq::commands::ConsumerInfo::browser [protected]

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

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

bool activemq::commands::ConsumerInfo::dispatchAsync [protected]

bool activemq::commands::ConsumerInfo::exclusive [protected]

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

int activemq::commands::ConsumerInfo::maximumPendingMessageLimit [protected]

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

bool activemq::commands::ConsumerInfo::networkSubscription [protected]

bool activemq::commands::ConsumerInfo::noLocal [protected]

bool activemq::commands::ConsumerInfo::noRangeAcks [protected]

bool activemq::commands::ConsumerInfo::optimizedAcknowledge [protected]

int activemq::commands::ConsumerInfo::prefetchSize [protected]

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

bool activemq::commands::ConsumerInfo::retroactive [protected]

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

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

---

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

• src/main/activemq/commands/ConsumerInfo.h