activemq-cpp-3.6.0
activemq::commands::ProducerAck Class Reference

#include <src/main/activemq/commands/ProducerAck.h>

Inheritance diagram for activemq::commands::ProducerAck:

Public Member Functions

 ProducerAck ()
virtual ~ProducerAck ()
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
virtual ProducerAckcloneDataStructure () const
 Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.
virtual void copyDataStructure (const DataStructure *src)
 Copy the contents of the passed object into this objects members, overwriting any existing data.
virtual std::string toString () const
 Returns a string containing the information for this DataStructure such as its type and value of its elements.
virtual bool equals (const DataStructure *value) const
 Compares the DataStructure passed in to this one, and returns if they are equivalent.
virtual const Pointer
< ProducerId > & 
getProducerId () const
virtual Pointer< ProducerId > & getProducerId ()
virtual void setProducerId (const Pointer< ProducerId > &producerId)
virtual int getSize () const
virtual void setSize (int size)
virtual bool isProducerAck () const
virtual Pointer< Commandvisit (activemq::state::CommandVisitor *visitor)
 Allows a Visitor to visit this command and return a response to the command based on the command type being visited.
- Public Member Functions inherited from activemq::commands::BaseCommand
 BaseCommand ()
virtual ~BaseCommand ()
virtual void setCommandId (int id)
 Sets the Command Id of this Message.
virtual int getCommandId () const
 Gets the Command Id of this Message.
virtual void setResponseRequired (const bool required)
 Set if this Message requires a Response.
virtual bool isResponseRequired () const
 Is a Response required for this Command.
virtual bool isBrokerInfo () const
virtual bool isControlCommand () const
virtual bool isConnectionControl () const
virtual bool isConnectionError () const
virtual bool isConnectionInfo () const
virtual bool isConsumerInfo () const
virtual bool isConsumerControl () const
virtual bool isDestinationInfo () const
virtual bool isFlushCommand () const
virtual bool isMessage () const
virtual bool isMessageAck () const
virtual bool isMessagePull () const
virtual bool isKeepAliveInfo () const
virtual bool isMessageDispatch () const
virtual bool isMessageDispatchNotification () const
virtual bool isProducerInfo () const
virtual bool isResponse () const
virtual bool isRemoveInfo () const
virtual bool isRemoveSubscriptionInfo () const
virtual bool isReplayCommand () const
virtual bool isSessionInfo () const
virtual bool isShutdownInfo () const
virtual bool isTransactionInfo () const
virtual bool isWireFormatInfo () const
- Public Member Functions inherited from activemq::commands::Command
virtual ~Command ()
- Public Member Functions inherited from activemq::commands::BaseDataStructure
virtual ~BaseDataStructure ()
virtual bool isMarshalAware () const
 Determine if the class implementing this interface is really wanting to be told about marshaling.
virtual void beforeMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void afterMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void beforeUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void afterUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void setMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED, const std::vector< char > &data AMQCPP_UNUSED)
virtual std::vector< unsigned
char > 
getMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void copyDataStructure (const DataStructure *src AMQCPP_UNUSED)
virtual bool equals (const DataStructure *value AMQCPP_UNUSED) const
- Public Member Functions inherited from activemq::commands::DataStructure
virtual ~DataStructure ()
- Public Member Functions inherited from activemq::wireformat::MarshalAware
virtual ~MarshalAware ()
virtual void beforeMarshal (WireFormat *wireFormat)=0
 Called before marshaling is started to prepare the object to be marshaled.
virtual void afterMarshal (WireFormat *wireFormat)=0
 Called after marshaling is started to cleanup the object being marshaled.
virtual void beforeUnmarshal (WireFormat *wireFormat)=0
 Called before unmarshaling is started to prepare the object to be unmarshaled.
virtual void afterUnmarshal (WireFormat *wireFormat)=0
 Called after unmarshaling is started to cleanup the object being unmarshaled.
virtual void setMarshaledForm (WireFormat *wireFormat, const std::vector< char > &data)=0
 Called to set the data to this object that will contain the objects marshaled form.
virtual std::vector< unsigned
char > 
getMarshaledForm (WireFormat *wireFormat)=0
 Called to get the data to this object that will contain the objects marshaled form.

Static Public Attributes

static const unsigned char ID_PRODUCERACK = 19

Protected Attributes

Pointer< ProducerIdproducerId
int size

Constructor & Destructor Documentation

activemq::commands::ProducerAck::ProducerAck ( )
virtual activemq::commands::ProducerAck::~ProducerAck ( )
virtual

Member Function Documentation

virtual ProducerAck* activemq::commands::ProducerAck::cloneDataStructure ( ) const
virtual

Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.

Returns
new copy of this object.

Implements activemq::commands::DataStructure.

virtual void activemq::commands::ProducerAck::copyDataStructure ( const DataStructure src)
virtual

Copy the contents of the passed object into this objects members, overwriting any existing data.

Returns
src - Source Object

Reimplemented from activemq::commands::BaseCommand.

virtual bool activemq::commands::ProducerAck::equals ( const DataStructure value) const
virtual

Compares the DataStructure passed in to this one, and returns if they are equivalent.

Equivalent here means that they are of the same type, and that each element of the objects are the same.

Returns
true if DataStructure's are Equal.

Reimplemented from activemq::commands::BaseCommand.

virtual unsigned char activemq::commands::ProducerAck::getDataStructureType ( ) const
virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns
The type of the data structure

Implements activemq::commands::DataStructure.

virtual const Pointer<ProducerId>& activemq::commands::ProducerAck::getProducerId ( ) const
virtual
virtual Pointer<ProducerId>& activemq::commands::ProducerAck::getProducerId ( )
virtual
virtual int activemq::commands::ProducerAck::getSize ( ) const
virtual
virtual bool activemq::commands::ProducerAck::isProducerAck ( ) const
inlinevirtual
Returns
an answer of true to the isProducerAck() query.

Reimplemented from activemq::commands::BaseCommand.

virtual void activemq::commands::ProducerAck::setProducerId ( const Pointer< ProducerId > &  producerId)
virtual
virtual void activemq::commands::ProducerAck::setSize ( int  size)
virtual
virtual std::string activemq::commands::ProducerAck::toString ( ) const
virtual

Returns a string containing the information for this DataStructure such as its type and value of its elements.

Returns
formatted string useful for debugging.

Reimplemented from activemq::commands::BaseCommand.

virtual Pointer<Command> activemq::commands::ProducerAck::visit ( activemq::state::CommandVisitor visitor)
virtual

Allows a Visitor to visit this command and return a response to the command based on the command type being visited.

The command will call the proper processXXX method in the visitor.

Returns
a Response to the visitor being called or NULL if no response.

Implements activemq::commands::Command.

Field Documentation

const unsigned char activemq::commands::ProducerAck::ID_PRODUCERACK = 19
static
Pointer<ProducerId> activemq::commands::ProducerAck::producerId
protected
int activemq::commands::ProducerAck::size
protected

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