Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_receipt_command.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_receipt_command.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_receipt_command.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_receipt_command.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,152 @@ + + +activemq-cpp: activemq::connector::stomp::commands::ReceiptCommand Class Reference + + + + +
+
+
+
+ +

activemq::connector::stomp::commands::ReceiptCommand Class Reference

#include <ReceiptCommand.h> +

+

Inheritance diagram for activemq::connector::stomp::commands::ReceiptCommand: +

+ +activemq::connector::stomp::commands::AbstractCommand< T > + +List of all members. + + + + + + + + + + + +

Public Member Functions

virtual const char * getReceiptId (void) const
virtual void setReceiptId (const std::string &id)

Protected Member Functions

virtual void initialize (StompFrame &frame)
virtual bool validate (const StompFrame &frame) const
+

Detailed Description

+Message sent from the Broker when a receipt is requested for messages that are sent. +

+


Member Function Documentation

+ +
+
+ + + + + + + + + +
virtual const char* activemq::connector::stomp::commands::ReceiptCommand::getReceiptId (void   )  const [inline, virtual]
+
+
+ +

+Get the receipt id

Returns:
the message id
+ +
+

+ +

+
+ + + + + + + + + +
virtual void activemq::connector::stomp::commands::ReceiptCommand::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< T >. +

+

+ +

+
+ + + + + + + + + +
virtual void activemq::connector::stomp::commands::ReceiptCommand::setReceiptId (const std::string &  id  )  [inline, virtual]
+
+
+ +

+Set the receipt id

Parameters:
+ + +
id the receipt id
+
+ +
+

+ +

+
+ + + + + + + + + +
virtual bool activemq::connector::stomp::commands::ReceiptCommand::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< T >. +

+

+


The documentation for this class was generated from the following file: +
Generated on Tue Aug 1 09:18:14 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_receipt_command.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_receipt_command.png?rev=428212&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_receipt_command.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,64 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::connector::stomp::commands::StompMessage< T > Member List

This is the complete list of members for activemq::connector::stomp::commands::StompMessage< T >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
acknowledge(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getBytes(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, protected, virtual]
getCMSCorrelationId(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSDeliveryMode(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSDestination(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSExpiration(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSMessageId(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSMessageType(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSPriority(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSRedelivered(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSReplyTo(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCMSTimeStamp(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getCommandId(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
getCorrelationId(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
getNumBytes(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, protected, virtual]
getProperties(void)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getRedeliveryCount(void) const activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
getStompCommandId(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
getTransactionId(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
initialize(StompFrame &frame)activemq::connector::stomp::commands::StompMessage< T > [inline, protected, virtual]
isResponseRequired(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
marshal(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
setAckHandler(core::ActiveMQAckHandler *handler)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setBytes(const char *bytes, const unsigned long numBytes, const bool setContentLength=true)activemq::connector::stomp::commands::AbstractCommand< T > [inline, protected, virtual]
setCMSCorrelationId(const std::string &correlationId)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSDeliveryMode(int mode)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSDestination(const cms::Destination *destination)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSExpiration(long expireTime)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSMessageId(const std::string &id)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSMessageType(const std::string &type)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSPriority(int priority)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSRedelivered(bool redelivered)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSReplyTo(const std::string &id)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCMSTimeStamp(long timeStamp)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setCommandId(const unsigned int id)activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
setCorrelationId(const unsigned int corrId)activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
setRedeliveryCount(int count)activemq::connector::stomp::commands::StompMessage< T > [inline, virtual]
setResponseRequired(const bool required)activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
setTransactionId(const std::string &id)activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
validate(const StompFrame &frame) const activemq::connector::stomp::commands::StompMessage< T > [inline, protected, virtual]


Generated on Tue Aug 1 09:18:14 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,796 @@ + + +activemq-cpp: activemq::connector::stomp::commands::StompMessage< T > Class Template Reference + + + + +
+
+
+
+ +

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

#include <StompMessage.h> +

+

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

+ +activemq::connector::stomp::commands::AbstractCommand< T > +activemq::core::ActiveMQMessage + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

virtual util::PropertiesgetProperties (void)
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::DestinationgetCMSDestination (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
+

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. +

+


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 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< T >. +

+

+ +

+
+
+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< T >. +

+

+ +

+
+
+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< T >. +

+

+


The documentation for this class was generated from the following file: +
Generated on Tue Aug 1 09:18:14 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message.png?rev=428212&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_stomp_message.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream