activemq::connector::stomp::commands::StompMessage< T > Class Template Reference

#include <StompMessage.h>

Inheritance diagram for activemq::connector::stomp::commands::StompMessage< T >:

List of all members.

Public Member Functions
	StompMessage (void)
	StompMessage (StompFrame *frame)
virtual	~StompMessage (void)
virtual util::Properties &	getProperties (void)
virtual const util::Properties &	getProperties (void) const
virtual const char *	getCMSCorrelationId (void) const
virtual void	setCMSCorrelationId (const std::string &correlationId)
virtual void	acknowledge (void) const throw ( cms::CMSException )
virtual int	getCMSDeliveryMode (void) const
virtual void	setCMSDeliveryMode (int mode)
virtual const cms::Destination *	getCMSDestination (void) const
virtual void	setCMSDestination (const cms::Destination *destination)
virtual long	getCMSExpiration (void) const
virtual void	setCMSExpiration (long expireTime)
virtual const char *	getCMSMessageId (void) const
virtual void	setCMSMessageId (const std::string &id)
virtual int	getCMSPriority (void) const
virtual void	setCMSPriority (int priority)
virtual bool	getCMSRedelivered (void) const
virtual void	setCMSRedelivered (bool redelivered)
virtual const char *	getCMSReplyTo (void) const
virtual void	setCMSReplyTo (const std::string &id)
virtual long	getCMSTimeStamp (void) const
virtual void	setCMSTimeStamp (long timeStamp)
virtual const char *	getCMSMessageType (void) const
virtual void	setCMSMessageType (const std::string &type)
virtual void	setAckHandler (core::ActiveMQAckHandler *handler)
virtual int	getRedeliveryCount (void) const
virtual void	setRedeliveryCount (int count)
Protected Member Functions
virtual void	initialize (StompFrame &frame)
virtual bool	validate (const StompFrame &frame) const
Private Attributes
core::ActiveMQAckHandler *	ackHandler
cms::Destination *	dest

---

Detailed Description

template<typename T>
class activemq::connector::stomp::commands::StompMessage< T >

Base class for Stomp Commands that represent the Active MQ message types. This class is templated and expects the Template type to be a cms::Message type, Message, TextMessage etc. This class will implement all the general cms:Message methods

This class implement AbsractCommand<StompCommnd> and the ActiveMQMessage interface.

---

Constructor & Destructor Documentation

template<typename T> activemq::connector::stomp::commands::StompMessage< T >::StompMessage (  void   )  [inline]

template<typename T> activemq::connector::stomp::commands::StompMessage< T >::StompMessage (  StompFrame *  frame  )  [inline]

template<typename T> virtual activemq::connector::stomp::commands::StompMessage< T >::~StompMessage (  void   )  [inline, virtual]

---

Member Function Documentation

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::acknowledge (  void   )  const throw ( cms::CMSException ) [inline, virtual]

Acknowledges all consumed messages of the session of this consumed message. Exceptions: CMSException

template<typename T> virtual const char* activemq::connector::stomp::commands::StompMessage< T >::getCMSCorrelationId (  void   )  const [inline, virtual]

Get the Correlation Id for this message Returns: string representation of the correlation Id

template<typename T> virtual int activemq::connector::stomp::commands::StompMessage< T >::getCMSDeliveryMode (  void   )  const [inline, virtual]

Sets the DeliveryMode for this message Returns: DeliveryMode enumerated value.

template<typename T> virtual const cms::Destination* activemq::connector::stomp::commands::StompMessage< T >::getCMSDestination (  void   )  const [inline, virtual]

Gets the Destination for this Message Returns: Destination object can be NULL

template<typename T> virtual long activemq::connector::stomp::commands::StompMessage< T >::getCMSExpiration (  void   )  const [inline, virtual]

Gets the Expiration Time for this Message Returns: time value

template<typename T> virtual const char* activemq::connector::stomp::commands::StompMessage< T >::getCMSMessageId (  void   )  const [inline, virtual]

Gets the CMS Message Id for this Message Returns: time value

template<typename T> virtual const char* activemq::connector::stomp::commands::StompMessage< T >::getCMSMessageType (  void   )  const [inline, virtual]

Gets the CMS Message Type for this Message Returns: type value

template<typename T> virtual int activemq::connector::stomp::commands::StompMessage< T >::getCMSPriority (  void   )  const [inline, virtual]

Gets the Priority Value for this Message Returns: priority value

template<typename T> virtual bool activemq::connector::stomp::commands::StompMessage< T >::getCMSRedelivered (  void   )  const [inline, virtual]

Gets the Redelivered Flag for this Message Returns: redelivered value

template<typename T> virtual const char* activemq::connector::stomp::commands::StompMessage< T >::getCMSReplyTo (  void   )  const [inline, virtual]

Gets the CMS Reply To Address for this Message Returns: Reply To Value

template<typename T> virtual long activemq::connector::stomp::commands::StompMessage< T >::getCMSTimeStamp (  void   )  const [inline, virtual]

Gets the Time Stamp for this Message Returns: time stamp value

template<typename T> virtual const util::Properties& activemq::connector::stomp::commands::StompMessage< T >::getProperties (  void   )  const [inline, virtual]

Reimplemented from activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

template<typename T> virtual util::Properties& activemq::connector::stomp::commands::StompMessage< T >::getProperties (  void   )  [inline, virtual]

Gets the properties map for this command. Returns: Reference to a Properties object Reimplemented from activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

template<typename T> virtual int activemq::connector::stomp::commands::StompMessage< T >::getRedeliveryCount (  void   )  const [inline, virtual]

Gets the number of times this message has been redelivered. Returns: redelivery count Implements activemq::core::ActiveMQMessage.

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::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 >.

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setAckHandler (  core::ActiveMQAckHandler *  handler  )  [inline, virtual]

Sets the Acknowledgement Handler that this Message will use when the Acknowledge method is called. Parameters: handler  ActiveMQAckHandler Implements activemq::core::ActiveMQMessage.

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSCorrelationId (  const std::string &  correlationId  )  [inline, virtual]

Sets the Correlation Id used by this message Parameters: correlationId  String representing the correlation id.

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSDeliveryMode (  int  mode  )  [inline, virtual]

Sets the DeliveryMode for this message Parameters: mode  DeliveryMode enumerated value.

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSDestination (  const cms::Destination *  destination  )  [inline, virtual]

Sets the Destination for this message Parameters: destination  Destination Object

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSExpiration (  long  expireTime  )  [inline, virtual]

Sets the Expiration Time for this message Parameters: expireTime  time value

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSMessageId (  const std::string &  id  )  [inline, virtual]

Sets the CMS Message Id for this message Parameters: id  time value

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSMessageType (  const std::string &  type  )  [inline, virtual]

Sets the CMS Message Type for this message Parameters: type  type value

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSPriority (  int  priority  )  [inline, virtual]

Sets the Priority Value for this message Parameters: priority  priority value

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSRedelivered (  bool  redelivered  )  [inline, virtual]

Sets the Redelivered Flag for this message Parameters: redelivered  redelivered value

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSReplyTo (  const std::string &  id  )  [inline, virtual]

Sets the CMS Reply To Address for this message Parameters: id  Reply To value

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setCMSTimeStamp (  long  timeStamp  )  [inline, virtual]

Sets the Time Stamp for this message Parameters: timeStamp  time stamp value

template<typename T> virtual void activemq::connector::stomp::commands::StompMessage< T >::setRedeliveryCount (  int  count  )  [inline, virtual]

Sets the count of the number of times this message has been redelivered Parameters: count  redelivery count Implements activemq::core::ActiveMQMessage.

template<typename T> virtual bool activemq::connector::stomp::commands::StompMessage< T >::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 >.

---

Member Data Documentation

template<typename T> core::ActiveMQAckHandler* activemq::connector::stomp::commands::StompMessage< T >::ackHandler [private]

template<typename T> cms::Destination* activemq::connector::stomp::commands::StompMessage< T >::dest [private]

---

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

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

---