activemq::commands::MessageAck Class Reference

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

Inheritance diagram for activemq::commands::MessageAck:

Public Member Functions
	MessageAck ()
virtual	~MessageAck ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual MessageAck *	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 const Pointer < TransactionId > &	getTransactionId () const
virtual Pointer< TransactionId > &	getTransactionId ()
virtual void	setTransactionId (const Pointer< TransactionId > &transactionId)
virtual const Pointer < ConsumerId > &	getConsumerId () const
virtual Pointer< ConsumerId > &	getConsumerId ()
virtual void	setConsumerId (const Pointer< ConsumerId > &consumerId)
virtual unsigned char	getAckType () const
virtual void	setAckType (unsigned char ackType)
virtual const Pointer < MessageId > &	getFirstMessageId () const
virtual Pointer< MessageId > &	getFirstMessageId ()
virtual void	setFirstMessageId (const Pointer< MessageId > &firstMessageId)
virtual const Pointer < MessageId > &	getLastMessageId () const
virtual Pointer< MessageId > &	getLastMessageId ()
virtual void	setLastMessageId (const Pointer< MessageId > &lastMessageId)
virtual int	getMessageCount () const
virtual void	setMessageCount (int messageCount)
virtual bool	isMessageAck () 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_MESSAGEACK = 22
Protected Attributes
Pointer< ActiveMQDestination >	destination
Pointer< TransactionId >	transactionId
Pointer< ConsumerId >	consumerId
unsigned char	ackType
Pointer< MessageId >	firstMessageId
Pointer< MessageId >	lastMessageId
int	messageCount

---

Constructor & Destructor Documentation

activemq::commands::MessageAck::MessageAck

(

)

virtual activemq::commands::MessageAck::~MessageAck

(

)

[virtual]

---

Member Function Documentation

virtual MessageAck* activemq::commands::MessageAck::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::MessageAck::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::MessageAck::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 unsigned char activemq::commands::MessageAck::getAckType

(

)

const [virtual]

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

(

)

const [virtual]

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

(

)

[virtual]

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

(

)

const [virtual]

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

(

)

[virtual]

virtual const Pointer<MessageId>& activemq::commands::MessageAck::getFirstMessageId

(

)

const [virtual]

virtual Pointer<MessageId>& activemq::commands::MessageAck::getFirstMessageId

(

)

[virtual]

virtual const Pointer<MessageId>& activemq::commands::MessageAck::getLastMessageId

(

)

const [virtual]

virtual Pointer<MessageId>& activemq::commands::MessageAck::getLastMessageId

(

)

[virtual]

virtual int activemq::commands::MessageAck::getMessageCount

(

)

const [virtual]

virtual const Pointer<TransactionId>& activemq::commands::MessageAck::getTransactionId

(

)

const [virtual]

virtual Pointer<TransactionId>& activemq::commands::MessageAck::getTransactionId

(

)

[virtual]

virtual bool activemq::commands::MessageAck::isMessageAck

(

)

const [inline, virtual]

Returns:

an answer of true to the isMessageAck() query.

Reimplemented from activemq::commands::BaseCommand.

virtual void activemq::commands::MessageAck::setAckType

(

unsigned char

ackType

)

[virtual]

virtual void activemq::commands::MessageAck::setConsumerId

(

const Pointer< ConsumerId > &

consumerId

)

[virtual]

virtual void activemq::commands::MessageAck::setDestination

(

const Pointer< ActiveMQDestination > &

destination

)

[virtual]

virtual void activemq::commands::MessageAck::setFirstMessageId

(

const Pointer< MessageId > &

firstMessageId

)

[virtual]

virtual void activemq::commands::MessageAck::setLastMessageId

(

const Pointer< MessageId > &

lastMessageId

)

[virtual]

virtual void activemq::commands::MessageAck::setMessageCount

(

int

messageCount

)

[virtual]

virtual void activemq::commands::MessageAck::setTransactionId

(

const Pointer< TransactionId > &

transactionId

)

[virtual]

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

unsigned char activemq::commands::MessageAck::ackType [protected]

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

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

Pointer<MessageId> activemq::commands::MessageAck::firstMessageId [protected]

const unsigned char activemq::commands::MessageAck::ID_MESSAGEACK = 22 [static]

Pointer<MessageId> activemq::commands::MessageAck::lastMessageId [protected]

int activemq::commands::MessageAck::messageCount [protected]

Pointer<TransactionId> activemq::commands::MessageAck::transactionId [protected]

---

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

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