cms::Message Class Reference

#include <Message.h>

Inheritance diagram for cms::Message:

List of all members.

Public Member Functions
virtual	~Message (void)
virtual Message *	clone (void) const =0
virtual void	acknowledge (void) const =0 throw ( CMSException )
virtual activemq::util::Properties &	getProperties (void)=0
virtual const activemq::util::Properties &	getProperties (void) const =0
virtual const char *	getCMSCorrelationId (void) const =0
virtual void	setCMSCorrelationId (const std::string &correlationId)=0
virtual int	getCMSDeliveryMode (void) const =0
virtual void	setCMSDeliveryMode (int mode)=0
virtual const Destination *	getCMSDestination (void) const =0
virtual void	setCMSDestination (const Destination *destination)=0
virtual long	getCMSExpiration (void) const =0
virtual void	setCMSExpiration (long expireTime)=0
virtual const char *	getCMSMessageId (void) const =0
virtual void	setCMSMessageId (const std::string &id)=0
virtual int	getCMSPriority (void) const =0
virtual void	setCMSPriority (int priority)=0
virtual bool	getCMSRedelivered (void) const =0
virtual void	setCMSRedelivered (bool redelivered)=0
virtual const char *	getCMSReplyTo (void) const =0
virtual void	setCMSReplyTo (const std::string &id)=0
virtual long	getCMSTimeStamp (void) const =0
virtual void	setCMSTimeStamp (long timeStamp)=0
virtual const char *	getCMSMessageType (void) const =0
virtual void	setCMSMessageType (const std::string &type)=0

---

Detailed Description

Root of all messages.

---

Constructor & Destructor Documentation

virtual cms::Message::~Message (  void   )  [inline, virtual]

---

Member Function Documentation

virtual void cms::Message::acknowledge (  void   )  const throw ( CMSException ) [pure virtual]

Acknowledges all consumed messages of the session of this consumed message.

virtual Message* cms::Message::clone (  void   )  const [pure virtual]

Clonse this message exactly, returns a new instance that the caller is required to delete. Returns: new copy of this message

virtual const char* cms::Message::getCMSCorrelationId (  void   )  const [pure virtual]

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

virtual int cms::Message::getCMSDeliveryMode (  void   )  const [pure virtual]

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

virtual const Destination* cms::Message::getCMSDestination (  void   )  const [pure virtual]

Gets the Destination for this Message, returns a Returns: Destination object

virtual long cms::Message::getCMSExpiration (  void   )  const [pure virtual]

Gets the Expiration Time for this Message Returns: time value

virtual const char* cms::Message::getCMSMessageId (  void   )  const [pure virtual]

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

virtual const char* cms::Message::getCMSMessageType (  void   )  const [pure virtual]

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

virtual int cms::Message::getCMSPriority (  void   )  const [pure virtual]

Gets the Priority Value for this Message Returns: priority value

virtual bool cms::Message::getCMSRedelivered (  void   )  const [pure virtual]

Gets the Redelivered Flag for this Message Returns: redelivered value

virtual const char* cms::Message::getCMSReplyTo (  void   )  const [pure virtual]

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

virtual long cms::Message::getCMSTimeStamp (  void   )  const [pure virtual]

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

virtual const activemq::util::Properties& cms::Message::getProperties (  void   )  const [pure virtual]

virtual activemq::util::Properties& cms::Message::getProperties (  void   )  [pure virtual]

Retrieves a reference to the properties object owned by this message Returns: A Properties Object reference

virtual void cms::Message::setCMSCorrelationId (  const std::string &  correlationId  )  [pure virtual]

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

virtual void cms::Message::setCMSDeliveryMode (  int  mode  )  [pure virtual]

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

virtual void cms::Message::setCMSDestination (  const Destination *  destination  )  [pure virtual]

Sets the Destination for this message Parameters: destination  - Destination Object

virtual void cms::Message::setCMSExpiration (  long  expireTime  )  [pure virtual]

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

virtual void cms::Message::setCMSMessageId (  const std::string &  id  )  [pure virtual]

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

virtual void cms::Message::setCMSMessageType (  const std::string &  type  )  [pure virtual]

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

virtual void cms::Message::setCMSPriority (  int  priority  )  [pure virtual]

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

virtual void cms::Message::setCMSRedelivered (  bool  redelivered  )  [pure virtual]

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

virtual void cms::Message::setCMSReplyTo (  const std::string &  id  )  [pure virtual]

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

virtual void cms::Message::setCMSTimeStamp (  long  timeStamp  )  [pure virtual]

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

---

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

• activemq-cpp/src/main/cms/Message.h

---