activemq::commands::DataStructure Class Reference

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

Inheritance diagram for activemq::commands::DataStructure:

Public Member Functions
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 std::string	toString () const =0
	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 =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 bool	isMarshalAware () const =0
	Determine if the class implementing this interface is really wanting to be told about marshaling.
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

virtual activemq::commands::DataStructure::~DataStructure ( )

inlinevirtual

Member Function Documentation

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

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

Implemented in activemq::commands::Message, activemq::commands::ActiveMQDestination, activemq::commands::ConsumerInfo, activemq::commands::MessageId, activemq::commands::SessionId, activemq::commands::ActiveMQBytesMessage, activemq::commands::BrokerInfo, activemq::commands::ConnectionInfo, activemq::commands::MessageAck, activemq::commands::BrokerError, activemq::commands::ProducerId, activemq::commands::ConnectionId, activemq::commands::ConsumerId, activemq::commands::ConnectionControl, activemq::commands::ConsumerControl, activemq::commands::JournalTopicAck, activemq::commands::ProducerInfo, activemq::commands::DestinationInfo, activemq::commands::MessagePull, activemq::commands::SessionInfo, activemq::commands::MessageDispatch, activemq::commands::MessageDispatchNotification, activemq::commands::ActiveMQTempDestination, activemq::commands::SubscriptionInfo, activemq::commands::XATransactionId, activemq::commands::TransactionInfo, activemq::commands::ConnectionError, activemq::commands::JournalQueueAck, activemq::commands::JournalTransaction, activemq::commands::RemoveSubscriptionInfo, activemq::commands::LocalTransactionId, activemq::commands::NetworkBridgeFilter, activemq::commands::ProducerAck, activemq::commands::RemoveInfo, activemq::commands::ActiveMQStreamMessage, activemq::commands::DataArrayResponse, activemq::commands::DataResponse, activemq::commands::DiscoveryEvent, activemq::commands::ExceptionResponse, activemq::commands::PartialCommand, activemq::commands::ReplayCommand, activemq::commands::BrokerId, activemq::commands::ControlCommand, activemq::commands::IntegerResponse, activemq::commands::JournalTrace, activemq::commands::Response, activemq::commands::ActiveMQMapMessage, activemq::commands::FlushCommand, activemq::commands::KeepAliveInfo, activemq::commands::LastPartialCommand, activemq::commands::ShutdownInfo, activemq::commands::TransactionId, activemq::commands::ActiveMQBlobMessage, activemq::commands::WireFormatInfo, activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTopic, activemq::commands::ActiveMQTextMessage, activemq::commands::ActiveMQMessage, activemq::commands::ActiveMQObjectMessage, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::BooleanExpression.

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

pure virtual

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

Returns

src - Source Object

Implemented in activemq::commands::Message, activemq::commands::ActiveMQDestination, activemq::commands::ConsumerInfo, activemq::commands::BrokerError, activemq::commands::MessageId, activemq::commands::SessionId, activemq::commands::ActiveMQBytesMessage, activemq::commands::BrokerInfo, activemq::commands::ConnectionInfo, activemq::commands::MessageAck, activemq::commands::ProducerId, activemq::commands::ConnectionId, activemq::commands::ConsumerId, activemq::commands::ConnectionControl, activemq::commands::ConsumerControl, activemq::commands::JournalTopicAck, activemq::commands::ProducerInfo, activemq::commands::ActiveMQTempDestination, activemq::commands::DestinationInfo, activemq::commands::MessagePull, activemq::commands::SessionInfo, activemq::commands::MessageDispatch, activemq::commands::MessageDispatchNotification, activemq::commands::SubscriptionInfo, activemq::commands::XATransactionId, activemq::commands::TransactionInfo, activemq::commands::ConnectionError, activemq::commands::JournalQueueAck, activemq::commands::JournalTransaction, activemq::commands::RemoveSubscriptionInfo, activemq::commands::LocalTransactionId, activemq::commands::NetworkBridgeFilter, activemq::commands::ProducerAck, activemq::commands::RemoveInfo, activemq::commands::ActiveMQStreamMessage, activemq::commands::DataArrayResponse, activemq::commands::DataResponse, activemq::commands::DiscoveryEvent, activemq::commands::ExceptionResponse, activemq::commands::PartialCommand, activemq::commands::ReplayCommand, activemq::commands::BrokerId, activemq::commands::ControlCommand, activemq::commands::IntegerResponse, activemq::commands::JournalTrace, activemq::commands::Response, activemq::commands::ActiveMQMapMessage, activemq::commands::FlushCommand, activemq::commands::KeepAliveInfo, activemq::commands::LastPartialCommand, activemq::commands::ShutdownInfo, activemq::commands::TransactionId, activemq::commands::ActiveMQBlobMessage, activemq::commands::WireFormatInfo, activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTopic, activemq::commands::ActiveMQTextMessage, activemq::commands::ActiveMQObjectMessage, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, activemq::commands::BaseCommand, and activemq::commands::ActiveMQMessage.

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

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

Implemented in activemq::commands::Message, activemq::commands::ActiveMQDestination, activemq::commands::ConsumerInfo, activemq::commands::MessageId, activemq::commands::SessionId, activemq::commands::ActiveMQBytesMessage, activemq::commands::BrokerInfo, activemq::commands::ConnectionInfo, activemq::commands::MessageAck, activemq::commands::BaseCommand, activemq::commands::ProducerId, activemq::commands::ConnectionId, activemq::commands::ActiveMQTempDestination, activemq::commands::ConsumerId, activemq::commands::ConnectionControl, activemq::commands::ConsumerControl, activemq::commands::JournalTopicAck, activemq::commands::ProducerInfo, activemq::commands::DestinationInfo, activemq::commands::MessagePull, activemq::commands::SessionInfo, activemq::commands::MessageDispatch, activemq::commands::MessageDispatchNotification, activemq::commands::SubscriptionInfo, activemq::commands::XATransactionId, activemq::commands::TransactionInfo, activemq::commands::ConnectionError, activemq::commands::JournalQueueAck, activemq::commands::JournalTransaction, activemq::commands::RemoveSubscriptionInfo, activemq::commands::LocalTransactionId, activemq::commands::NetworkBridgeFilter, activemq::commands::ProducerAck, activemq::commands::RemoveInfo, activemq::commands::ActiveMQMapMessage, activemq::commands::ActiveMQStreamMessage, activemq::commands::DataArrayResponse, activemq::commands::DataResponse, activemq::commands::DiscoveryEvent, activemq::commands::ExceptionResponse, activemq::commands::PartialCommand, activemq::commands::ReplayCommand, activemq::commands::BrokerId, activemq::commands::ControlCommand, activemq::commands::IntegerResponse, activemq::commands::JournalTrace, activemq::commands::Response, activemq::commands::FlushCommand, activemq::commands::KeepAliveInfo, activemq::commands::LastPartialCommand, activemq::commands::ShutdownInfo, activemq::commands::TransactionId, activemq::commands::ActiveMQMessageTemplate< T >, 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 >, activemq::commands::ActiveMQMessageTemplate< cms::ObjectMessage >, activemq::commands::ActiveMQBlobMessage, activemq::commands::WireFormatInfo, activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTopic, activemq::commands::ActiveMQTextMessage, activemq::commands::ActiveMQObjectMessage, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, activemq::commands::ActiveMQMessage, and activemq::commands::BooleanExpression.

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

pure virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns

The type of the data structure

Implemented in activemq::commands::Message, activemq::commands::ActiveMQDestination, activemq::commands::ConsumerInfo, activemq::commands::MessageId, activemq::commands::SessionId, activemq::commands::ActiveMQBytesMessage, activemq::commands::BrokerInfo, activemq::commands::ConnectionInfo, activemq::commands::MessageAck, activemq::commands::ProducerId, activemq::commands::ConnectionId, activemq::commands::ConsumerId, activemq::commands::ConnectionControl, activemq::commands::ConsumerControl, activemq::commands::JournalTopicAck, activemq::commands::ProducerInfo, activemq::commands::DestinationInfo, activemq::commands::MessagePull, activemq::commands::SessionInfo, activemq::commands::MessageDispatch, activemq::commands::MessageDispatchNotification, activemq::commands::ActiveMQTempDestination, activemq::commands::SubscriptionInfo, activemq::commands::XATransactionId, activemq::commands::BrokerError, activemq::commands::TransactionInfo, activemq::commands::ConnectionError, activemq::commands::JournalQueueAck, activemq::commands::JournalTransaction, activemq::commands::RemoveSubscriptionInfo, activemq::commands::LocalTransactionId, activemq::commands::NetworkBridgeFilter, activemq::commands::ProducerAck, activemq::commands::RemoveInfo, activemq::commands::ActiveMQStreamMessage, activemq::commands::DataArrayResponse, activemq::commands::DataResponse, activemq::commands::DiscoveryEvent, activemq::commands::ExceptionResponse, activemq::commands::PartialCommand, activemq::commands::ReplayCommand, activemq::commands::BrokerId, activemq::commands::ControlCommand, activemq::commands::IntegerResponse, activemq::commands::JournalTrace, activemq::commands::Response, activemq::commands::FlushCommand, activemq::commands::KeepAliveInfo, activemq::commands::LastPartialCommand, activemq::commands::ShutdownInfo, activemq::commands::TransactionId, activemq::commands::ActiveMQMapMessage, activemq::commands::ActiveMQBlobMessage, activemq::commands::WireFormatInfo, activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTopic, activemq::commands::ActiveMQTextMessage, activemq::commands::ActiveMQObjectMessage, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQMessage.

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

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

Implemented in activemq::commands::Message, activemq::commands::ActiveMQDestination, activemq::commands::ConsumerInfo, activemq::commands::MessageId, activemq::commands::SessionId, activemq::commands::ActiveMQBytesMessage, activemq::commands::BrokerInfo, activemq::commands::ConnectionInfo, activemq::commands::MessageAck, activemq::commands::ProducerId, activemq::commands::ConnectionId, activemq::commands::ActiveMQTempDestination, activemq::commands::ConsumerId, activemq::commands::ConnectionControl, activemq::commands::ConsumerControl, activemq::commands::JournalTopicAck, activemq::commands::ProducerInfo, activemq::commands::DestinationInfo, activemq::commands::MessagePull, activemq::commands::SessionInfo, activemq::commands::MessageDispatch, activemq::commands::MessageDispatchNotification, activemq::commands::SubscriptionInfo, activemq::commands::XATransactionId, activemq::commands::TransactionInfo, activemq::commands::ConnectionError, activemq::commands::JournalQueueAck, activemq::commands::JournalTransaction, activemq::commands::RemoveSubscriptionInfo, activemq::commands::LocalTransactionId, activemq::commands::NetworkBridgeFilter, activemq::commands::ProducerAck, activemq::commands::RemoveInfo, activemq::commands::ActiveMQMapMessage, activemq::commands::ActiveMQStreamMessage, activemq::commands::DataArrayResponse, activemq::commands::DataResponse, activemq::commands::DiscoveryEvent, activemq::commands::ExceptionResponse, activemq::commands::PartialCommand, activemq::commands::ReplayCommand, activemq::commands::BrokerId, activemq::commands::ControlCommand, activemq::commands::IntegerResponse, activemq::commands::JournalTrace, activemq::commands::Response, activemq::commands::FlushCommand, activemq::commands::KeepAliveInfo, activemq::commands::LastPartialCommand, activemq::commands::ShutdownInfo, activemq::commands::TransactionId, activemq::commands::BaseCommand, activemq::commands::ActiveMQBlobMessage, activemq::commands::Command, activemq::commands::WireFormatInfo, activemq::commands::ActiveMQQueue, activemq::commands::BaseDataStructure, activemq::commands::ActiveMQTopic, activemq::commands::ActiveMQTextMessage, activemq::commands::ActiveMQObjectMessage, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, activemq::commands::ActiveMQMessage, and activemq::commands::BooleanExpression.

---

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

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