activemq::commands::ConsumerControl Class Reference

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

Inheritance diagram for activemq::commands::ConsumerControl:

Public Member Functions
	ConsumerControl ()
virtual	~ConsumerControl ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual ConsumerControl *	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.
virtual const Pointer < ActiveMQDestination > &	getDestination () const
virtual Pointer < ActiveMQDestination > &	getDestination ()
virtual void	setDestination (const Pointer< ActiveMQDestination > &destination)
virtual bool	isClose () const
virtual void	setClose (bool close)
virtual const Pointer < ConsumerId > &	getConsumerId () const
virtual Pointer< ConsumerId > &	getConsumerId ()
virtual void	setConsumerId (const Pointer< ConsumerId > &consumerId)
virtual int	getPrefetch () const
virtual void	setPrefetch (int prefetch)
virtual bool	isFlush () const
virtual void	setFlush (bool flush)
virtual bool	isStart () const
virtual void	setStart (bool start)
virtual bool	isStop () const
virtual void	setStop (bool stop)
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_CONSUMERCONTROL = 17
Protected Attributes
Pointer< ActiveMQDestination >	destination
bool	close
Pointer< ConsumerId >	consumerId
int	prefetch
bool	flush
bool	start
bool	stop

---

Constructor & Destructor Documentation

activemq::commands::ConsumerControl::ConsumerControl

(

)

virtual activemq::commands::ConsumerControl::~ConsumerControl

(

)

[virtual]

---

Member Function Documentation

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

virtual bool activemq::commands::ConsumerControl::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<ConsumerId>& activemq::commands::ConsumerControl::getConsumerId

(

)

const [virtual]

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

(

)

[virtual]

virtual unsigned char activemq::commands::ConsumerControl::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::ConsumerControl::getDestination

(

)

const [virtual]

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

(

)

[virtual]

virtual int activemq::commands::ConsumerControl::getPrefetch

(

)

const [virtual]

virtual bool activemq::commands::ConsumerControl::isClose

(

)

const [virtual]

virtual bool activemq::commands::ConsumerControl::isFlush

(

)

const [virtual]

virtual bool activemq::commands::ConsumerControl::isStart

(

)

const [virtual]

virtual bool activemq::commands::ConsumerControl::isStop

(

)

const [virtual]

virtual void activemq::commands::ConsumerControl::setClose

(

bool

close

)

[virtual]

virtual void activemq::commands::ConsumerControl::setConsumerId

(

const Pointer< ConsumerId > &

consumerId

)

[virtual]

virtual void activemq::commands::ConsumerControl::setDestination

(

const Pointer< ActiveMQDestination > &

destination

)

[virtual]

virtual void activemq::commands::ConsumerControl::setFlush

(

bool

flush

)

[virtual]

virtual void activemq::commands::ConsumerControl::setPrefetch

(

int

prefetch

)

[virtual]

virtual void activemq::commands::ConsumerControl::setStart

(

bool

start

)

[virtual]

virtual void activemq::commands::ConsumerControl::setStop

(

bool

stop

)

[virtual]

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

bool activemq::commands::ConsumerControl::close [protected]

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

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

bool activemq::commands::ConsumerControl::flush [protected]

const unsigned char activemq::commands::ConsumerControl::ID_CONSUMERCONTROL = 17 [static]

int activemq::commands::ConsumerControl::prefetch [protected]

bool activemq::commands::ConsumerControl::start [protected]

bool activemq::commands::ConsumerControl::stop [protected]

---

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

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