Added: incubator/activemq/site/cms/html/classcms_1_1Message.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classcms_1_1Message.html?rev=428531&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classcms_1_1Message.html (added) +++ incubator/activemq/site/cms/html/classcms_1_1Message.html Thu Aug 3 14:24:12 2006 @@ -0,0 +1,860 @@ + + +cms: cms::Message Class Reference + + + + +
+
+
+
+ +

cms::Message Class Reference

#include <Message.h> +

+

Inheritance diagram for cms::Message: +

+ +cms::BytesMessage +cms::MapMessage +cms::TextMessage + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

virtual ~Message (void)
virtual Messageclone (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 DestinationgetCMSDestination (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: +
Generated on Thu Aug 3 16:39:15 2006 for cms by  + +doxygen 1.4.5
+ + Propchange: incubator/activemq/site/cms/html/classcms_1_1Message.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/activemq/site/cms/html/classcms_1_1Message.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classcms_1_1Message.png?rev=428531&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/activemq/site/cms/html/classcms_1_1Message.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/activemq/site/cms/html/classcms_1_1MessageConsumer-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classcms_1_1MessageConsumer-members.html?rev=428531&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classcms_1_1MessageConsumer-members.html (added) +++ incubator/activemq/site/cms/html/classcms_1_1MessageConsumer-members.html Thu Aug 3 14:24:12 2006 @@ -0,0 +1,34 @@ + + +cms: Member List + + + + +
+
+
+
+

cms::MessageConsumer Member List

This is the complete list of members for cms::MessageConsumer, including all inherited members.

+ + + + + + + +
getMessageListener(void) const =0cms::MessageConsumer [pure virtual]
getMessageSelector(void) const =0cms::MessageConsumer [pure virtual]
receive(void)=0cms::MessageConsumer [pure virtual]
receive(int millisecs)=0cms::MessageConsumer [pure virtual]
receiveNoWait(void)=0cms::MessageConsumer [pure virtual]
setMessageListener(MessageListener *listener)=0cms::MessageConsumer [pure virtual]
~MessageConsumer(void)cms::MessageConsumer [inline, virtual]


Generated on Thu Aug 3 16:39:15 2006 for cms by  + +doxygen 1.4.5
+ + Propchange: incubator/activemq/site/cms/html/classcms_1_1MessageConsumer-members.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/activemq/site/cms/html/classcms_1_1MessageConsumer.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classcms_1_1MessageConsumer.html?rev=428531&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classcms_1_1MessageConsumer.html (added) +++ incubator/activemq/site/cms/html/classcms_1_1MessageConsumer.html Thu Aug 3 14:24:12 2006 @@ -0,0 +1,282 @@ + + +cms: cms::MessageConsumer Class Reference + + + + +
+
+
+
+ +

cms::MessageConsumer Class Reference

#include <MessageConsumer.h> +

+List of all members. + + + + + + + + + + + + + + + + +

Public Member Functions

virtual ~MessageConsumer (void)
virtual Messagereceive (void)=0 throw ( CMSException )
virtual Messagereceive (int millisecs)=0 throw ( CMSException )
virtual MessagereceiveNoWait (void)=0 throw ( CMSException )
virtual void setMessageListener (MessageListener *listener)=0
virtual MessageListenergetMessageListener (void) const =0
virtual std::string getMessageSelector (void) const =0 throw ( cms::CMSException )
+


Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
virtual cms::MessageConsumer::~MessageConsumer void   )  [inline, virtual]
+
+ + + + + +
+   + + +

+

+


Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
virtual MessageListener* cms::MessageConsumer::getMessageListener void   )  const [pure virtual]
+
+ + + + + +
+   + + +

+Gets the MessageListener that this class will send notifs on

Parameters:
+ + +
MessageListener interface pointer
+
+
+

+ + + + +
+ + + + + + + + + +
virtual std::string cms::MessageConsumer::getMessageSelector void   )  const throw ( cms::CMSException ) [pure virtual]
+
+ + + + + +
+   + + +

+Gets this message consumer's message selector expression.

Returns:
This Consumer's selector expression or "".
+
Exceptions:
+ + +
cms::CMSException 
+
+
+

+ + + + +
+ + + + + + + + + +
virtual Message* cms::MessageConsumer::receive int  millisecs  )  throw ( CMSException ) [pure virtual]
+
+ + + + + +
+   + + +

+Synchronously Receive a Message, time out after defined interval. Returns null if nothing read.

Returns:
new message
+
Exceptions:
+ + +
CMSException 
+
+
+

+ + + + +
+ + + + + + + + + +
virtual Message* cms::MessageConsumer::receive void   )  throw ( CMSException ) [pure virtual]
+
+ + + + + +
+   + + +

+Synchronously Receive a Message

Returns:
new message
+
Exceptions:
+ + +
CMSException 
+
+
+

+ + + + +
+ + + + + + + + + +
virtual Message* cms::MessageConsumer::receiveNoWait void   )  throw ( CMSException ) [pure virtual]
+
+ + + + + +
+   + + +

+Receive a Message, does not wait if there isn't a new message to read, returns NULL if nothing read.

Returns:
new message
+
Exceptions:
+ + +
CMSException 
+
+
+

+ + + + +
+ + + + + + + + + +
virtual void cms::MessageConsumer::setMessageListener MessageListener listener  )  [pure virtual]
+
+ + + + + +
+   + + +

+Sets the MessageListener that this class will send notifs on

Parameters:
+ + +
MessageListener interface pointer
+
+
+


The documentation for this class was generated from the following file: +
Generated on Thu Aug 3 16:39:15 2006 for cms by  + +doxygen 1.4.5
+ + Propchange: incubator/activemq/site/cms/html/classcms_1_1MessageConsumer.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/activemq/site/cms/html/classcms_1_1MessageListener-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classcms_1_1MessageListener-members.html?rev=428531&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classcms_1_1MessageListener-members.html (added) +++ incubator/activemq/site/cms/html/classcms_1_1MessageListener-members.html Thu Aug 3 14:24:12 2006 @@ -0,0 +1,29 @@ + + +cms: Member List + + + + +
+
+
+
+

cms::MessageListener Member List

This is the complete list of members for cms::MessageListener, including all inherited members.

+ + +
onMessage(const Message *message)=0cms::MessageListener [pure virtual]
~MessageListener(void)cms::MessageListener [inline, virtual]


Generated on Thu Aug 3 16:39:15 2006 for cms by  + +doxygen 1.4.5
+ + Propchange: incubator/activemq/site/cms/html/classcms_1_1MessageListener-members.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/activemq/site/cms/html/classcms_1_1MessageListener.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classcms_1_1MessageListener.html?rev=428531&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classcms_1_1MessageListener.html (added) +++ incubator/activemq/site/cms/html/classcms_1_1MessageListener.html Thu Aug 3 14:24:12 2006 @@ -0,0 +1,105 @@ + + +cms: cms::MessageListener Class Reference + + + + +
+
+
+
+ +

cms::MessageListener Class Reference

#include <MessageListener.h> +

+List of all members. + + + + + + +

Public Member Functions

virtual ~MessageListener (void)
virtual void onMessage (const Message *message)=0
+


Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
virtual cms::MessageListener::~MessageListener void   )  [inline, virtual]
+
+ + + + + +
+   + + +

+

+


Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
virtual void cms::MessageListener::onMessage const Message message  )  [pure virtual]
+
+ + + + + +
+   + + +

+Called asynchronously when a new message is received, the message reference can be to any othe Message types. a dynamic cast is used to find out what type of message this is. The lifetime of this object is only garunteed to be for life of the onMessage function after this returns the message may no longer exists. User should copy the data or clone the message if they wish to keep something around about this message.

+It is considered a programming error for this method to throw and exception.

+

Parameters:
+ + +
Message object const pointer recipient does not own.
+
+
+


The documentation for this class was generated from the following file: +
Generated on Thu Aug 3 16:39:15 2006 for cms by  + +doxygen 1.4.5
+ + Propchange: incubator/activemq/site/cms/html/classcms_1_1MessageListener.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/activemq/site/cms/html/classcms_1_1MessageProducer-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classcms_1_1MessageProducer-members.html?rev=428531&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classcms_1_1MessageProducer-members.html (added) +++ incubator/activemq/site/cms/html/classcms_1_1MessageProducer-members.html Thu Aug 3 14:24:12 2006 @@ -0,0 +1,40 @@ + + +cms: Member List + + + + +
+
+
+
+

cms::MessageProducer Member List

This is the complete list of members for cms::MessageProducer, including all inherited members.

+ + + + + + + + + + + + + +
getDeliveryMode(void) const =0cms::MessageProducer [pure virtual]
getDisableMessageId(void) const =0cms::MessageProducer [pure virtual]
getDisableMessageTimeStamp(void) const =0cms::MessageProducer [pure virtual]
getPriority(void) const =0cms::MessageProducer [pure virtual]
getTimeToLive(void) const =0cms::MessageProducer [pure virtual]
send(Message *message)=0cms::MessageProducer [pure virtual]
send(const Destination *destination, Message *message)=0cms::MessageProducer [pure virtual]
setDeliveryMode(int mode)=0cms::MessageProducer [pure virtual]
setDisableMessageId(bool value)=0cms::MessageProducer [pure virtual]
setDisableMessageTimeStamp(bool value)=0cms::MessageProducer [pure virtual]
setPriority(int priority)=0cms::MessageProducer [pure virtual]
setTimeToLive(int time)=0cms::MessageProducer [pure virtual]
~MessageProducer(void)cms::MessageProducer [inline, virtual]


Generated on Thu Aug 3 16:39:15 2006 for cms by  + +doxygen 1.4.5
+ + Propchange: incubator/activemq/site/cms/html/classcms_1_1MessageProducer-members.html ------------------------------------------------------------------------------ svn:eol-style = native