activemq::commands::BaseCommand Class Reference

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

Inheritance diagram for activemq::commands::BaseCommand:

Public Member Functions
	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 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 bool	isConnectionControl () const
virtual bool	isConnectionInfo () const
virtual bool	isConsumerInfo () const
virtual bool	isBrokerInfo () const
virtual bool	isMessage () const
virtual bool	isMessageAck () const
virtual bool	isKeepAliveInfo () const
virtual bool	isMessageDispatch () const
virtual bool	isMessageDispatchNotification () const
virtual bool	isProducerAck () const
virtual bool	isProducerInfo () const
virtual bool	isResponse () const
virtual bool	isRemoveInfo () const
virtual bool	isRemoveSubscriptionInfo () const
virtual bool	isShutdownInfo () const
virtual bool	isTransactionInfo () const
virtual bool	isWireFormatInfo () const

---

Constructor & Destructor Documentation

activemq::commands::BaseCommand::BaseCommand

(

)

[inline]

virtual activemq::commands::BaseCommand::~BaseCommand

(

)

[inline, virtual]

---

Member Function Documentation

virtual void activemq::commands::BaseCommand::copyDataStructure

(

const DataStructure *

src

)

[inline, virtual]

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

Returns:

src - Source Object

Implements activemq::commands::DataStructure.

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

References getCommandId(), and isResponseRequired().

virtual bool activemq::commands::BaseCommand::equals

(

const DataStructure *

value

)

const [inline, 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.

Implements activemq::commands::DataStructure.

Reimplemented in activemq::commands::ActiveMQBlobMessage, activemq::commands::ActiveMQBytesMessage, activemq::commands::ActiveMQMapMessage, activemq::commands::ActiveMQMessage, activemq::commands::ActiveMQMessageTemplate< T >, activemq::commands::ActiveMQObjectMessage, activemq::commands::ActiveMQStreamMessage, activemq::commands::ActiveMQTextMessage, activemq::commands::BrokerInfo, activemq::commands::ConnectionControl, activemq::commands::ConnectionError, activemq::commands::ConnectionInfo, activemq::commands::ConsumerControl, activemq::commands::ConsumerInfo, activemq::commands::ControlCommand, activemq::commands::DataArrayResponse, activemq::commands::DataResponse, activemq::commands::DestinationInfo, activemq::commands::ExceptionResponse, activemq::commands::FlushCommand, activemq::commands::IntegerResponse, activemq::commands::KeepAliveInfo, activemq::commands::Message, activemq::commands::MessageAck, activemq::commands::MessageDispatch, activemq::commands::MessageDispatchNotification, activemq::commands::MessagePull, activemq::commands::ProducerAck, activemq::commands::ProducerInfo, activemq::commands::RemoveInfo, activemq::commands::RemoveSubscriptionInfo, activemq::commands::ReplayCommand, activemq::commands::Response, activemq::commands::SessionInfo, activemq::commands::ShutdownInfo, activemq::commands::TransactionInfo, activemq::commands::WireFormatInfo, activemq::commands::ActiveMQMessageTemplate< cms::BytesMessage >, activemq::commands::ActiveMQMessageTemplate< cms::MapMessage >, activemq::commands::ActiveMQMessageTemplate< cms::Message >, activemq::commands::ActiveMQMessageTemplate< cms::StreamMessage >, activemq::commands::ActiveMQMessageTemplate< cms::TextMessage >, and activemq::commands::ActiveMQMessageTemplate< cms::ObjectMessage >.

References activemq::commands::BaseDataStructure::equals().

virtual int activemq::commands::BaseCommand::getCommandId

(

)

const [inline, virtual]

Gets the Command Id of this Message.

Returns:

Command Id

Implements activemq::commands::Command.

Referenced by copyDataStructure().

virtual bool activemq::commands::BaseCommand::isBrokerInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::BrokerInfo.

virtual bool activemq::commands::BaseCommand::isConnectionControl

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::ConnectionControl.

virtual bool activemq::commands::BaseCommand::isConnectionInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::ConnectionInfo.

virtual bool activemq::commands::BaseCommand::isConsumerInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::ConsumerInfo.

virtual bool activemq::commands::BaseCommand::isKeepAliveInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::KeepAliveInfo.

virtual bool activemq::commands::BaseCommand::isMessage

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::Message.

virtual bool activemq::commands::BaseCommand::isMessageAck

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::MessageAck.

virtual bool activemq::commands::BaseCommand::isMessageDispatch

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::MessageDispatch.

virtual bool activemq::commands::BaseCommand::isMessageDispatchNotification

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::MessageDispatchNotification.

virtual bool activemq::commands::BaseCommand::isProducerAck

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::ProducerAck.

virtual bool activemq::commands::BaseCommand::isProducerInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::ProducerInfo.

virtual bool activemq::commands::BaseCommand::isRemoveInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::RemoveInfo.

virtual bool activemq::commands::BaseCommand::isRemoveSubscriptionInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::RemoveSubscriptionInfo.

virtual bool activemq::commands::BaseCommand::isResponse

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::Response.

virtual bool activemq::commands::BaseCommand::isResponseRequired

(

)

const [inline, virtual]

Is a Response required for this Command.

Returns:

true if a response is required.

Implements activemq::commands::Command.

Referenced by copyDataStructure().

virtual bool activemq::commands::BaseCommand::isShutdownInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::ShutdownInfo.

virtual bool activemq::commands::BaseCommand::isTransactionInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::TransactionInfo.

virtual bool activemq::commands::BaseCommand::isWireFormatInfo

(

)

const [inline, virtual]

Implements activemq::commands::Command.

Reimplemented in activemq::commands::WireFormatInfo.

virtual void activemq::commands::BaseCommand::setCommandId

(

int

id

)

[inline, virtual]

Sets the Command Id of this Message.

Parameters:

id	Command Id

Implements activemq::commands::Command.

virtual void activemq::commands::BaseCommand::setResponseRequired

(

const bool

required

)

[inline, virtual]

Set if this Message requires a Response.

Parameters:

required

true if response is required

Implements activemq::commands::Command.

virtual std::string activemq::commands::BaseCommand::toString

(

)

const [inline, 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.

Implements activemq::commands::Command.

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

References activemq::commands::BaseDataStructure::toString().

---

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

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