activemq::commands::MessagePull Class Reference

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

Inheritance diagram for activemq::commands::MessagePull:

[legend]

Public Member Functions
	MessagePull ()
virtual	~MessagePull ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual MessagePull *	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)
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 < ConsumerId > &	getConsumerId () const
virtual Pointer< ConsumerId > &	getConsumerId ()
virtual void	setConsumerId (const Pointer< ConsumerId > &consumerId)
virtual const Pointer < ActiveMQDestination > &	getDestination () const
virtual Pointer < ActiveMQDestination > &	getDestination ()
virtual void	setDestination (const Pointer< ActiveMQDestination > &destination)
virtual long long	getTimeout () const
virtual void	setTimeout (long long timeout)
virtual const std::string &	getCorrelationId () const
virtual std::string &	getCorrelationId ()
virtual void	setCorrelationId (const std::string &correlationId)
virtual const Pointer < MessageId > &	getMessageId () const
virtual Pointer< MessageId > &	getMessageId ()
virtual void	setMessageId (const Pointer< MessageId > &messageId)
virtual bool	isMessagePull () 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_MESSAGEPULL = 20
Protected Attributes
Pointer< ConsumerId >	consumerId
Pointer< ActiveMQDestination >	destination
long long	timeout
std::string	correlationId
Pointer< MessageId >	messageId

---

Constructor & Destructor Documentation

activemq::commands::MessagePull::MessagePull

(

)

virtual activemq::commands::MessagePull::~MessagePull

(

)

[virtual]

---

Member Function Documentation

virtual MessagePull* activemq::commands::MessagePull::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::MessagePull::copyDataStructure

(

const DataStructure *

src

)

[virtual]

Reimplemented from activemq::commands::BaseCommand.

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

(

)

[virtual]

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

(

)

const [virtual]

virtual std::string& activemq::commands::MessagePull::getCorrelationId

(

)

[virtual]

virtual const std::string& activemq::commands::MessagePull::getCorrelationId

(

)

const [virtual]

virtual unsigned char activemq::commands::MessagePull::getDataStructureType

(

)

const [virtual]

Get the DataStructure Type as defined in CommandTypes.h.

Returns:

The type of the data structure

Implements activemq::commands::DataStructure.

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

(

)

[virtual]

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

(

)

const [virtual]

virtual Pointer<MessageId>& activemq::commands::MessagePull::getMessageId

(

)

[virtual]

virtual const Pointer<MessageId>& activemq::commands::MessagePull::getMessageId

(

)

const [virtual]

virtual long long activemq::commands::MessagePull::getTimeout

(

)

const [virtual]

virtual bool activemq::commands::MessagePull::isMessagePull

(

)

const [inline, virtual]

Returns:

an answer of true to the isMessagePull() query.

Reimplemented from activemq::commands::BaseCommand.

virtual void activemq::commands::MessagePull::setConsumerId

(

const Pointer< ConsumerId > &

consumerId

)

[virtual]

virtual void activemq::commands::MessagePull::setCorrelationId

(

const std::string &

correlationId

)

[virtual]

virtual void activemq::commands::MessagePull::setDestination

(

const Pointer< ActiveMQDestination > &

destination

)

[virtual]

virtual void activemq::commands::MessagePull::setMessageId

(

const Pointer< MessageId > &

messageId

)

[virtual]

virtual void activemq::commands::MessagePull::setTimeout

(

long long

timeout

)

[virtual]

virtual std::string activemq::commands::MessagePull::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::MessagePull::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<ConsumerId> activemq::commands::MessagePull::consumerId [protected]

std::string activemq::commands::MessagePull::correlationId [protected]

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

const unsigned char activemq::commands::MessagePull::ID_MESSAGEPULL = 20 [static]

Pointer<MessageId> activemq::commands::MessagePull::messageId [protected]

long long activemq::commands::MessagePull::timeout [protected]

---

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

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