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

Inheritance diagram for activemq::transport::Command:

Public Member Functions
virtual	~Command ()
virtual void	setCommandId (int id)=0
	Sets the Command Id of this Message.
virtual int	getCommandId () const=0
	Gets the Command Id of this Message.
virtual void	setResponseRequired (const bool required)=0
	Set if this Message requires a Response.
virtual bool	isResponseRequired () const=0
	Is a Response required for this Command.
virtual std::string	toString () const=0
	Returns a provider-specific string that provides information about the contents of the command.
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.
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.
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.
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.
virtual void	copyDataStructure (const DataStructure *src)=0
	Copy the contents of the passed object into this objects members, overwriting any existing data.
virtual bool	equals (const DataStructure *value) const =0
	Compares the DataStructure passed in to this one, and returns if they are equivalent.
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.

Constructor & Destructor Documentation

◆ ~Command()

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

inlinevirtual

Member Function Documentation

◆ getCommandId()

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

pure virtual

Gets the Command Id of this Message.

Returns: Command Id

◆ isBrokerInfo()

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

pure virtual

◆ isConnectionControl()

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

pure virtual

◆ isConnectionError()

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

pure virtual

◆ isConnectionInfo()

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

pure virtual

◆ isConsumerControl()

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

pure virtual

◆ isConsumerInfo()

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

pure virtual

◆ isControlCommand()

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

pure virtual

◆ isDestinationInfo()

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

pure virtual

◆ isFlushCommand()

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

pure virtual

◆ isKeepAliveInfo()

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

pure virtual

◆ isMessage()

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

pure virtual

◆ isMessageAck()

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

pure virtual

◆ isMessageDispatch()

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

pure virtual

◆ isMessageDispatchNotification()

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

pure virtual

◆ isMessagePull()

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

pure virtual

◆ isProducerAck()

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

pure virtual

◆ isProducerInfo()

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

pure virtual

◆ isRemoveInfo()

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

pure virtual

◆ isRemoveSubscriptionInfo()

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

pure virtual

◆ isReplayCommand()

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

pure virtual

◆ isResponse()

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

pure virtual

◆ isResponseRequired()

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

pure virtual

Is a Response required for this Command.

Returns: true if a response is required.

◆ isSessionInfo()

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

pure virtual

◆ isShutdownInfo()

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

pure virtual

◆ isTransactionInfo()

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

pure virtual

◆ isWireFormatInfo()

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

pure virtual

◆ setCommandId()

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

pure virtual

Sets the Command Id of this Message.

Parameters

id	Command Id

◆ setResponseRequired()

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

◆ toString()

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.

◆ visit()

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.

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

src/main/activemq/commands/Command.h

Public Member Functions

Constructor & Destructor Documentation

◆ ~Command()

Member Function Documentation

◆ getCommandId()

◆ isBrokerInfo()

◆ isConnectionControl()

◆ isConnectionError()

◆ isConnectionInfo()

◆ isConsumerControl()

◆ isConsumerInfo()

◆ isControlCommand()

◆ isDestinationInfo()

◆ isFlushCommand()

◆ isKeepAliveInfo()

◆ isMessage()

◆ isMessageAck()

◆ isMessageDispatch()

◆ isMessageDispatchNotification()

◆ isMessagePull()

◆ isProducerAck()

◆ isProducerInfo()

◆ isRemoveInfo()

◆ isRemoveSubscriptionInfo()

◆ isReplayCommand()

◆ isResponse()

◆ isResponseRequired()

◆ isSessionInfo()

◆ isShutdownInfo()

◆ isTransactionInfo()

◆ isWireFormatInfo()

◆ setCommandId()

◆ setResponseRequired()

◆ toString()

◆ visit()