activemq::connector::stomp::commands::AckCommand Class Reference

#include <AckCommand.h>

Inheritance diagram for activemq::connector::stomp::commands::AckCommand:

List of all members.

Public Member Functions
	AckCommand (void)
	AckCommand (StompFrame *frame)
virtual	~AckCommand (void)
virtual const char *	getMessageId (void) const
virtual void	setMessageId (const std::string &messageId)
Protected Member Functions
virtual void	initialize (StompFrame &frame)
virtual bool	validate (const StompFrame &frame) const

---

Detailed Description

Stomp Command that Represents Acknowledgement of a message receive. The Ack Command has one required attribute, message Id. For each message sent to the client from the broker, the message will not be considered consumed until an Ack is sent. Optionally a Transaction Id can be set that indicates that the message acknowledgement should be part of a named transaction.

---

Constructor & Destructor Documentation

activemq::connector::stomp::commands::AckCommand::AckCommand (  void   )  [inline]

activemq::connector::stomp::commands::AckCommand::AckCommand (  StompFrame *  frame  )  [inline]

virtual activemq::connector::stomp::commands::AckCommand::~AckCommand (  void   )  [inline, virtual]

---

Member Function Documentation

virtual const char* activemq::connector::stomp::commands::AckCommand::getMessageId (  void   )  const [inline, virtual]

Get the Message Id of this Command Returns: the Id of the Message

virtual void activemq::connector::stomp::commands::AckCommand::initialize (  StompFrame &  frame  )  [inline, protected, virtual]

Inheritors are required to override this method to init the frame with data appropriate for the command type. Parameters: frame  Frame to init Implements activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual void activemq::connector::stomp::commands::AckCommand::setMessageId (  const std::string &  messageId  )  [inline, virtual]

Set the Message Id that this Ack is associated with Parameters: messageId  the Message Id

virtual bool activemq::connector::stomp::commands::AckCommand::validate (  const StompFrame &  frame  )  const [inline, protected, virtual]

Inheritors are required to override this method to validate the passed stomp frame before it is marshalled or unmarshaled Parameters: frame  Frame to validate Returns: true if frame is valid Implements activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

---

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

• activemq-cpp/src/main/activemq/connector/stomp/commands/AckCommand.h

---