activemq::commands::Command Class Reference

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

Inheritance diagram for activemq::commands::Command:

Public Member Functions
virtual	~Command ()
virtual void	setCommandId (int id)=0
	Sets the Command Id of this Message. More...
virtual int	getCommandId () const =0
	Gets the Command Id of this Message. More...
virtual void	setResponseRequired (const bool required)=0
	Set if this Message requires a Response. More...
virtual bool	isResponseRequired () const =0
	Is a Response required for this Command. More...
virtual std::string	toString () const =0
	Returns a provider-specific string that provides information about the contents of the command. More...
virtual decaf::lang::Pointer < commands::Command >	visit (activemq::state::CommandVisitor *visitor)=0
	Allows a Visitor to visit this command and return a response to the command based on the command type being visited. More...
virtual bool	isBrokerInfo () const =0
virtual bool	isControlCommand () const =0
virtual bool	isConnectionControl () const =0
virtual bool	isConnectionInfo () const =0
virtual bool	isConnectionError () const =0
virtual bool	isConsumerInfo () const =0
virtual bool	isConsumerControl () const =0
virtual bool	isDestinationInfo () const =0
virtual bool	isFlushCommand () const =0
virtual bool	isKeepAliveInfo () const =0
virtual bool	isMessage () const =0
virtual bool	isMessageAck () const =0
virtual bool	isMessagePull () const =0
virtual bool	isMessageDispatch () const =0
virtual bool	isMessageDispatchNotification () const =0
virtual bool	isProducerAck () const =0
virtual bool	isProducerInfo () const =0
virtual bool	isResponse () const =0
virtual bool	isReplayCommand () const =0
virtual bool	isRemoveInfo () const =0
virtual bool	isRemoveSubscriptionInfo () const =0
virtual bool	isSessionInfo () const =0
virtual bool	isShutdownInfo () const =0
virtual bool	isTransactionInfo () const =0
virtual bool	isWireFormatInfo () const =0
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. More...
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 ()
virtual unsigned char	getDataStructureType () const =0
	Get the DataStructure Type as defined in CommandTypes.h. More...
virtual DataStructure *	cloneDataStructure () const =0
	Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one. More...
virtual void	copyDataStructure (const DataStructure *src)=0
	Copy the contents of the passed object into this objects members, overwriting any existing data. More...
virtual bool	equals (const DataStructure *value) const =0
	Compares the DataStructure passed in to this one, and returns if they are equivalent. More...
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. More...
virtual void	afterMarshal (WireFormat *wireFormat)=0
	Called after marshaling is started to cleanup the object being marshaled. More...
virtual void	beforeUnmarshal (WireFormat *wireFormat)=0
	Called before unmarshaling is started to prepare the object to be unmarshaled. More...
virtual void	afterUnmarshal (WireFormat *wireFormat)=0
	Called after unmarshaling is started to cleanup the object being unmarshaled. More...
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. More...
virtual std::vector< unsigned char >	getMarshaledForm (WireFormat *wireFormat)=0
	Called to get the data to this object that will contain the objects marshaled form. More...

Constructor & Destructor Documentation

virtual activemq::commands::Command::~Command ( )

inlinevirtual

Member Function Documentation

virtual int activemq::commands::Command::getCommandId ( ) const

pure virtual

Gets the Command Id of this Message.

Returns

Command Id

Implemented in activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isBrokerInfo ( ) const

pure virtual

Implemented in activemq::commands::BrokerInfo, and activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isConnectionControl ( ) const

pure virtual

Implemented in activemq::commands::ConnectionControl, and activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isConnectionError ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::ConnectionError.

virtual bool activemq::commands::Command::isConnectionInfo ( ) const

pure virtual

Implemented in activemq::commands::ConnectionInfo, and activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isConsumerControl ( ) const

pure virtual

Implemented in activemq::commands::ConsumerControl, and activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isConsumerInfo ( ) const

pure virtual

Implemented in activemq::commands::ConsumerInfo, and activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isControlCommand ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::ControlCommand.

virtual bool activemq::commands::Command::isDestinationInfo ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isFlushCommand ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::FlushCommand.

virtual bool activemq::commands::Command::isKeepAliveInfo ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::KeepAliveInfo.

virtual bool activemq::commands::Command::isMessage ( ) const

pure virtual

Implemented in activemq::commands::Message, and activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isMessageAck ( ) const

pure virtual

Implemented in activemq::commands::MessageAck, and activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isMessageDispatch ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::MessageDispatch.

virtual bool activemq::commands::Command::isMessageDispatchNotification ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::MessageDispatchNotification.

virtual bool activemq::commands::Command::isMessagePull ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::MessagePull.

virtual bool activemq::commands::Command::isProducerAck ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::ProducerAck.

virtual bool activemq::commands::Command::isProducerInfo ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::ProducerInfo.

virtual bool activemq::commands::Command::isRemoveInfo ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::RemoveInfo.

virtual bool activemq::commands::Command::isRemoveSubscriptionInfo ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::RemoveSubscriptionInfo.

virtual bool activemq::commands::Command::isReplayCommand ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::ReplayCommand.

virtual bool activemq::commands::Command::isResponse ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::Response.

virtual bool activemq::commands::Command::isResponseRequired ( ) const

pure virtual

Is a Response required for this Command.

Returns

true if a response is required.

Implemented in activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isSessionInfo ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand.

virtual bool activemq::commands::Command::isShutdownInfo ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::ShutdownInfo.

virtual bool activemq::commands::Command::isTransactionInfo ( ) const

pure virtual

Implemented in activemq::commands::BaseCommand, and activemq::commands::TransactionInfo.

virtual bool activemq::commands::Command::isWireFormatInfo ( ) const

pure virtual

Implemented in activemq::commands::WireFormatInfo, and activemq::commands::BaseCommand.

virtual void activemq::commands::Command::setCommandId ( int  id )

pure virtual

Sets the Command Id of this Message.

Parameters

id	Command Id

Implemented in activemq::commands::BaseCommand.

virtual void activemq::commands::Command::setResponseRequired ( const bool  required )

pure virtual

Set if this Message requires a Response.

Parameters

required

true if response is required

Implemented in activemq::commands::BaseCommand.

virtual std::string activemq::commands::Command::toString ( ) const

pure virtual

Returns a provider-specific string that provides information about the contents of the command.

Reimplemented from activemq::commands::BaseDataStructure.

Implemented in activemq::commands::Message, activemq::commands::ConsumerInfo, activemq::commands::MessageAck, activemq::commands::BrokerInfo, activemq::commands::ConnectionInfo, activemq::commands::MessageDispatch, activemq::commands::ConnectionControl, activemq::commands::ConsumerControl, activemq::commands::ProducerInfo, activemq::commands::ActiveMQBytesMessage, activemq::commands::DestinationInfo, activemq::commands::MessagePull, activemq::commands::SessionInfo, activemq::commands::MessageDispatchNotification, activemq::commands::TransactionInfo, activemq::commands::ConnectionError, activemq::commands::RemoveSubscriptionInfo, activemq::commands::ProducerAck, activemq::commands::RemoveInfo, activemq::commands::DataArrayResponse, activemq::commands::DataResponse, activemq::commands::ExceptionResponse, activemq::commands::ReplayCommand, activemq::commands::ControlCommand, activemq::commands::IntegerResponse, activemq::commands::Response, activemq::commands::FlushCommand, activemq::commands::KeepAliveInfo, activemq::commands::ShutdownInfo, activemq::commands::ActiveMQStreamMessage, activemq::commands::BaseCommand, activemq::commands::ActiveMQMapMessage, activemq::commands::WireFormatInfo, activemq::commands::ActiveMQBlobMessage, activemq::commands::ActiveMQTextMessage, activemq::commands::ActiveMQObjectMessage, and activemq::commands::ActiveMQMessage.

virtual decaf::lang::Pointer<commands::Command> activemq::commands::Command::visit ( activemq::state::CommandVisitor *  visitor )

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

Implemented in activemq::commands::Message, activemq::commands::ConsumerInfo, activemq::commands::MessageAck, activemq::commands::BrokerInfo, activemq::commands::ConnectionInfo, activemq::commands::ConnectionControl, activemq::commands::ConsumerControl, activemq::commands::MessageDispatch, activemq::commands::ProducerInfo, activemq::commands::MessagePull, activemq::commands::MessageDispatchNotification, activemq::commands::DestinationInfo, activemq::commands::BrokerError, activemq::commands::RemoveSubscriptionInfo, activemq::commands::TransactionInfo, activemq::commands::SessionInfo, activemq::commands::ConnectionError, activemq::commands::ProducerAck, activemq::commands::RemoveInfo, activemq::commands::ReplayCommand, activemq::commands::ControlCommand, activemq::commands::Response, activemq::commands::FlushCommand, activemq::commands::KeepAliveInfo, activemq::commands::ShutdownInfo, and activemq::commands::WireFormatInfo.

---

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

• src/main/activemq/commands/Command.h