From activemq-commits-return-3036-apmail-geronimo-activemq-commits-archive=geronimo.apache.org@geronimo.apache.org Thu Aug 03 02:26:27 2006 Return-Path: Delivered-To: apmail-geronimo-activemq-commits-archive@www.apache.org Received: (qmail 74644 invoked from network); 3 Aug 2006 02:26:27 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 3 Aug 2006 02:26:27 -0000 Received: (qmail 20875 invoked by uid 500); 3 Aug 2006 02:26:27 -0000 Delivered-To: apmail-geronimo-activemq-commits-archive@geronimo.apache.org Received: (qmail 20861 invoked by uid 500); 3 Aug 2006 02:26:26 -0000 Mailing-List: contact activemq-commits-help@geronimo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: activemq-dev@geronimo.apache.org Delivered-To: mailing list activemq-commits@geronimo.apache.org Received: (qmail 20801 invoked by uid 99); 3 Aug 2006 02:26:26 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 02 Aug 2006 19:26:26 -0700 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received-SPF: pass (asf.osuosl.org: local policy) Received: from [140.211.166.113] (HELO eris.apache.org) (140.211.166.113) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 02 Aug 2006 19:26:15 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id 5F7D81A9827; Wed, 2 Aug 2006 19:25:31 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r428212 [6/28] - in /incubator/activemq/site/cms: ./ html/ Date: Thu, 03 Aug 2006 02:24:54 -0000 To: activemq-commits@geronimo.apache.org From: jstrachan@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20060803022531.5F7D81A9827@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_abstract_command.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_abstract_command.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_abstract_command.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_abstract_command.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,517 @@ + + +activemq-cpp: activemq::connector::stomp::commands::AbstractCommand< T > Class Template Reference + + + + + + + +

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

#include <AbstractCommand.h> +

+

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

+ +activemq::connector::stomp::commands::AbortCommand +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::StompMessage< cms::BytesMessage > +activemq::connector::stomp::commands::StompMessage< cms::Message > +activemq::connector::stomp::commands::StompMessage< cms::TextMessage > +activemq::connector::stomp::commands::SubscribeCommand +activemq::connector::stomp::commands::UnsubscribeCommand + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

virtual util::PropertiesgetProperties (void)
virtual void setCommandId (const unsigned int id)
virtual unsigned int getCommandId (void) const
virtual void setResponseRequired (const bool required)
virtual bool isResponseRequired (void) const
virtual unsigned int getCorrelationId (void) const
virtual void setCorrelationId (const unsigned int corrId)
virtual const char * getTransactionId (void) const
virtual void setTransactionId (const std::string &id)
virtual CommandConstants::CommandId getStompCommandId (void) const
virtual const StompFramemarshal (void) const throw (marshal::MarshalException)

Protected Member Functions

virtual void initialize (StompFrame &frame)=0
virtual bool validate (const StompFrame &frame) const =0
virtual unsigned long getNumBytes (void) const
virtual const char * getBytes (void) const
virtual void setBytes (const char *bytes, const unsigned long numBytes, const bool setContentLength=true)
+

Detailed Description

+

template<typename T>
+ class activemq::connector::stomp::commands::AbstractCommand< T >

+ +Interface for all Stomp commands. Commands wrap around a stomp frame and provide their own marshalling to and from frames. Stomp frame objects are dumb and have a generic interface that becomes cumbersome to use directly. Commands help to abstract the stomp frame by providing a more user-friendly interface to the frame content. +

+


Member Function Documentation

+ +
+
+
+template<typename T>
+ + + + + + + + + +
virtual const char* activemq::connector::stomp::commands::AbstractCommand< T >::getBytes (void   )  const [inline, protected, virtual]
+
+
+ +

+Returns a char array of bytes that are contained in the message

Returns:
pointer to array of bytes.
+ +
+

+ +

+
+
+template<typename T>
+ + + + + + + + + +
virtual unsigned int activemq::connector::stomp::commands::AbstractCommand< T >::getCommandId (void   )  const [inline, virtual]
+
+
+ +

+Gets the Command Id of this Message

Returns:
Command Id
+ +
+

+ +

+
+
+template<typename T>
+ + + + + + + + + +
virtual unsigned int activemq::connector::stomp::commands::AbstractCommand< T >::getCorrelationId (void   )  const [inline, virtual]
+
+
+ +

+Gets the Correlation Id that is associated with this message

Returns:
the Correlation Id
+ +
+

+ +

+
+
+template<typename T>
+ + + + + + + + + +
virtual unsigned long activemq::connector::stomp::commands::AbstractCommand< T >::getNumBytes (void   )  const [inline, protected, virtual]
+
+
+ +

+Fetch the number of bytes in the Stomp Frame Body

Returns:
number of bytes
+ +
+

+ +

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

+ +

+
+
+template<typename T>
+ + + + + + + + + +
virtual CommandConstants::CommandId activemq::connector::stomp::commands::AbstractCommand< T >::getStompCommandId (void   )  const [inline, virtual]
+
+
+ +

+Retrieve the Stomp Command Id for this message.

Returns:
Stomp CommandId enum
+ +
+

+ +

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

+Get the Transaction Id of this Command

Returns:
the Id of the Transaction
+ +
+

+ +

+ +

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

+Is a Response required for this Command

Returns:
true if a response is required.
+ +
+

+ +

+
+
+template<typename T>
+ + + + + + + + + +
virtual const StompFrame& activemq::connector::stomp::commands::AbstractCommand< T >::marshal (void   )  const throw (marshal::MarshalException) [inline, virtual]
+
+
+ +

+Marshals the command to a stomp frame.

Returns:
the stomp frame representation of this command.
+
Exceptions:
+ + +
MarshalException if the command is not in a state that can be marshaled.
+
+ +
+

+ +

+
+
+template<typename T>
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void activemq::connector::stomp::commands::AbstractCommand< T >::setBytes (const char *  bytes,
const unsigned long  numBytes,
const bool  setContentLength = true 
) [inline, protected, virtual]
+
+
+ +

+Set the bytes that are to be sent in the body of this message the content length flag indicates if the Content Length header should be set.

Parameters:
+ + + + +
bytes to store
numBytes number of bytes to pull from the bytes buffer
setContentLength true if the content length header should be set
+
+ +
+

+ +

+
+
+template<typename T>
+ + + + + + + + + +
virtual void activemq::connector::stomp::commands::AbstractCommand< T >::setCommandId (const unsigned int  id  )  [inline, virtual]
+
+
+ +

+Sets the Command Id of this Message

Parameters:
+ + +
id Command Id
+
+ +
+

+ +

+
+
+template<typename T>
+ + + + + + + + + +
virtual void activemq::connector::stomp::commands::AbstractCommand< T >::setCorrelationId (const unsigned int  corrId  )  [inline, virtual]
+
+
+ +

+Sets the Correlation Id if this Command

Parameters:
+ + +
corrId Id
+
+ +
+

+ +

+
+
+template<typename T>
+ + + + + + + + + +
virtual void activemq::connector::stomp::commands::AbstractCommand< T >::setResponseRequired (const bool  required  )  [inline, virtual]
+
+
+ +

+Set if this Message requires a Response

Parameters:
+ + +
required true if response is required
+
+ +
+

+ +

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

+Set the Transaction Id of this Command

Parameters:
+ + +
id the Id of the Transaction
+
+ +
+

+ +

+


The documentation for this class was generated from the following file:
    +
  • C:/Apps/main/activemq/connector/stomp/commands/AbstractCommand.h
+
Generated on Tue Aug 1 09:18:13 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_abstract_command.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_abstract_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_abstract_command.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_ack_command-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_ack_command-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_ack_command-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_ack_command-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,42 @@ + + +activemq-cpp: Member List + + + + + + +

activemq::connector::stomp::commands::AckCommand Member List

This is the complete list of members for activemq::connector::stomp::commands::AckCommand, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
getBytes(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, protected, virtual]
getCommandId(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
getCorrelationId(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, virtual]
getMessageId(void) const activemq::connector::stomp::commands::AckCommand [inline, virtual]
getNumBytes(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, protected, virtual]
getProperties(void)activemq::connector::stomp::commands::AbstractCommand< 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::AckCommand [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]
setBytes(const char *bytes, const unsigned long numBytes, const bool setContentLength=true)activemq::connector::stomp::commands::AbstractCommand< T > [inline, protected, 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]
setMessageId(const std::string &messageId)activemq::connector::stomp::commands::AckCommand [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::AckCommand [inline, protected, virtual]


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

activemq::connector::stomp::commands::AckCommand Class Reference

#include <AckCommand.h> +

+

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

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

Public Member Functions

virtual const char * getMessageId (void) const
virtual void setMessageId (const std::string &messageId)

Protected Member Functions

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

Detailed Description

+Stomp Command that Represents Acknowledgement of a message receive. The Ack Command has one required attribute, message Id. For each message sent to the client from the broker, the message will not be considered consumed until an Ack is sent. Optionally a Transaction Id can be set that indicates that the message acknowledgement should be part of a named transaction. +

+


Member Function Documentation

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

+Get the Message Id of this Command

Returns:
the Id of the Message
+ +
+

+ +

+
+ + + + + + + + + +
virtual void activemq::connector::stomp::commands::AckCommand::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::AckCommand::setMessageId (const std::string &  messageId  )  [inline, virtual]
+
+
+ +

+Set the Message Id that this Ack is associated with

Parameters:
+ + +
messageId the Message Id
+
+ +
+

+ +

+
+ + + + + + + + + +
virtual bool activemq::connector::stomp::commands::AckCommand::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:
    +
  • C:/Apps/main/activemq/connector/stomp/commands/AckCommand.h
+
Generated on Tue Aug 1 09:18:13 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_ack_command.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_ack_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_ack_command.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_begin_command-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_begin_command-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_begin_command-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_begin_command-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,40 @@ + + +activemq-cpp: Member List + + + + + + +

activemq::connector::stomp::commands::BeginCommand Member List

This is the complete list of members for activemq::connector::stomp::commands::BeginCommand, including all inherited members.

+ + + + + + + + + + + + + + + + +
getBytes(void) const activemq::connector::stomp::commands::AbstractCommand< T > [inline, protected, 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::AbstractCommand< 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::BeginCommand [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]
setBytes(const char *bytes, const unsigned long numBytes, const bool setContentLength=true)activemq::connector::stomp::commands::AbstractCommand< T > [inline, protected, 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]
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::BeginCommand [inline, protected, virtual]


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

activemq::connector::stomp::commands::BeginCommand Class Reference

#include <BeginCommand.h> +

+

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

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

Protected Member Functions

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

Detailed Description

+Begins a Transaction. Transactions in this case apply to sending and acknowledging -- any messages sent or acknowledged during a transaction will be handled atomically based on the transaction.

+A transaction Identifier is required and this id will be used for all sends, commits, aborts, or acks. +

+


Member Function Documentation

+ +
+
+ + + + + + + + + +
virtual void activemq::connector::stomp::commands::BeginCommand::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 bool activemq::connector::stomp::commands::BeginCommand::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:
    +
  • C:/Apps/main/activemq/connector/stomp/commands/BeginCommand.h
+
Generated on Tue Aug 1 09:18:13 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_begin_command.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1connector_1_1stomp_1_1commands_1_1_begin_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_begin_command.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream