activemq::connector::stomp::commands::StompCommand Class Reference

#include <StompCommand.h>

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

List of all members.

Public Member Functions
virtual	~StompCommand (void)
virtual void	setCommandId (const unsigned int id)=0
virtual unsigned int	getCommandId (void) const =0
virtual void	setResponseRequired (const bool required)=0
virtual bool	isResponseRequired (void) const =0
virtual unsigned int	getCorrelationId (void) const =0
virtual void	setCorrelationId (const unsigned int corrId)=0
virtual const char *	getTransactionId (void) const =0
virtual void	setTransactionId (const std::string &id)=0
virtual CommandConstants::CommandId	getStompCommandId (void) const =0
virtual util::Properties &	getProperties (void)=0
virtual const util::Properties &	getProperties (void) const =0
Protected Member Functions
virtual void	initialize (StompFrame &frame)=0
virtual bool	validate (const StompFrame &frame) const =0

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

virtual unsigned int activemq::connector::stomp::commands::StompCommand::getCommandId (  void   )  const [pure virtual]

Gets the Command Id of this Message Returns: Command Id Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual unsigned int activemq::connector::stomp::commands::StompCommand::getCorrelationId (  void   )  const [pure virtual]

Gets the Correlation Id that is associated with this message Returns: the Correlation Id Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual const util::Properties& activemq::connector::stomp::commands::StompCommand::getProperties (  void   )  const [pure virtual]

Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::StompMessage< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, activemq::connector::stomp::commands::AbstractCommand< transport::Command >, activemq::connector::stomp::commands::StompMessage< cms::BytesMessage >, activemq::connector::stomp::commands::StompMessage< cms::Message >, and activemq::connector::stomp::commands::StompMessage< cms::TextMessage >.

virtual util::Properties& activemq::connector::stomp::commands::StompCommand::getProperties (  void   )  [pure virtual]

Retrieves the Properties that are part of this command Returns: const reference to a properties object Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::StompMessage< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, activemq::connector::stomp::commands::AbstractCommand< transport::Command >, activemq::connector::stomp::commands::StompMessage< cms::BytesMessage >, activemq::connector::stomp::commands::StompMessage< cms::Message >, and activemq::connector::stomp::commands::StompMessage< cms::TextMessage >.

virtual CommandConstants::CommandId activemq::connector::stomp::commands::StompCommand::getStompCommandId (  void   )  const [pure virtual]

Retrieve the Stomp Command Id for this message. Returns: Stomp CommandId enum Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual const char* activemq::connector::stomp::commands::StompCommand::getTransactionId (  void   )  const [pure virtual]

Get the Transaction Id of this Command Returns: the Id of the Transaction Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

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

Inheritors are required to override this method to init the frame with data appropriate for the command type. Parameters: frame  Frame to init Implemented in activemq::connector::stomp::commands::AbortCommand, activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AckCommand, activemq::connector::stomp::commands::BeginCommand, activemq::connector::stomp::commands::CommitCommand, activemq::connector::stomp::commands::ConnectCommand, activemq::connector::stomp::commands::ConnectedCommand, activemq::connector::stomp::commands::DisconnectCommand, activemq::connector::stomp::commands::ErrorCommand, activemq::connector::stomp::commands::ReceiptCommand, activemq::connector::stomp::commands::StompMessage< T >, activemq::connector::stomp::commands::SubscribeCommand, activemq::connector::stomp::commands::UnsubscribeCommand, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, activemq::connector::stomp::commands::AbstractCommand< transport::Command >, activemq::connector::stomp::commands::StompMessage< cms::BytesMessage >, activemq::connector::stomp::commands::StompMessage< cms::Message >, and activemq::connector::stomp::commands::StompMessage< cms::TextMessage >.

virtual bool activemq::connector::stomp::commands::StompCommand::isResponseRequired (  void   )  const [pure virtual]

Is a Response required for this Command Returns: true if a response is required. Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual void activemq::connector::stomp::commands::StompCommand::setCommandId (  const unsigned int  id  )  [pure virtual]

Sets the Command Id of this Message Parameters: id  Command Id Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual void activemq::connector::stomp::commands::StompCommand::setCorrelationId (  const unsigned int  corrId  )  [pure virtual]

Sets the Correlation Id if this Command Parameters: corrId  Id Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual void activemq::connector::stomp::commands::StompCommand::setResponseRequired (  const bool  required  )  [pure virtual]

Set if this Message requires a Response Parameters: required  true if response is required Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual void activemq::connector::stomp::commands::StompCommand::setTransactionId (  const std::string &  id  )  [pure virtual]

Set the Transaction Id of this Command Parameters: id  the Id of the Transaction Implemented in activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, and activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual bool activemq::connector::stomp::commands::StompCommand::validate (  const StompFrame &  frame  )  const [protected, pure 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 Implemented in activemq::connector::stomp::commands::AbortCommand, activemq::connector::stomp::commands::AbstractCommand< T >, activemq::connector::stomp::commands::AckCommand, activemq::connector::stomp::commands::BeginCommand, activemq::connector::stomp::commands::CommitCommand, activemq::connector::stomp::commands::ConnectCommand, activemq::connector::stomp::commands::ConnectedCommand, activemq::connector::stomp::commands::DisconnectCommand, activemq::connector::stomp::commands::ErrorCommand, activemq::connector::stomp::commands::ReceiptCommand, activemq::connector::stomp::commands::StompMessage< T >, activemq::connector::stomp::commands::SubscribeCommand, activemq::connector::stomp::commands::UnsubscribeCommand, activemq::connector::stomp::commands::AbstractCommand< transport::Response >, activemq::connector::stomp::commands::AbstractCommand< transport::Command >, activemq::connector::stomp::commands::StompMessage< cms::BytesMessage >, activemq::connector::stomp::commands::StompMessage< cms::Message >, and activemq::connector::stomp::commands::StompMessage< cms::TextMessage >.

---

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

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

---