activemq-cpp-3.4.0

activemq::commands::DestinationInfo Class Reference

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

Inheritance diagram for activemq::commands::DestinationInfo:

Public Member Functions

 DestinationInfo ()
virtual ~DestinationInfo ()
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
virtual DestinationInfocloneDataStructure () 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
< ConnectionId > & 
getConnectionId () const
virtual Pointer< ConnectionId > & getConnectionId ()
virtual void setConnectionId (const Pointer< ConnectionId > &connectionId)
virtual const Pointer
< ActiveMQDestination > & 
getDestination () const
virtual Pointer
< ActiveMQDestination > & 
getDestination ()
virtual void setDestination (const Pointer< ActiveMQDestination > &destination)
virtual unsigned char getOperationType () const
virtual void setOperationType (unsigned char operationType)
virtual long long getTimeout () const
virtual void setTimeout (long long timeout)
virtual const std::vector
< decaf::lang::Pointer
< BrokerId > > & 
getBrokerPath () const
virtual std::vector
< decaf::lang::Pointer
< BrokerId > > & 
getBrokerPath ()
virtual void setBrokerPath (const std::vector< decaf::lang::Pointer< BrokerId > > &brokerPath)
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.

Static Public Attributes

static const unsigned char ID_DESTINATIONINFO = 8

Protected Attributes

Pointer< ConnectionIdconnectionId
Pointer< ActiveMQDestinationdestination
unsigned char operationType
long long timeout
std::vector
< decaf::lang::Pointer
< BrokerId > > 
brokerPath

Constructor & Destructor Documentation

activemq::commands::DestinationInfo::DestinationInfo ( )
virtual activemq::commands::DestinationInfo::~DestinationInfo ( ) [virtual]

Member Function Documentation

virtual DestinationInfo* activemq::commands::DestinationInfo::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::DestinationInfo::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::DestinationInfo::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 const std::vector< decaf::lang::Pointer<BrokerId> >& activemq::commands::DestinationInfo::getBrokerPath ( ) const [virtual]
virtual std::vector< decaf::lang::Pointer<BrokerId> >& activemq::commands::DestinationInfo::getBrokerPath ( ) [virtual]
virtual const Pointer<ConnectionId>& activemq::commands::DestinationInfo::getConnectionId ( ) const [virtual]
virtual Pointer<ConnectionId>& activemq::commands::DestinationInfo::getConnectionId ( ) [virtual]
virtual unsigned char activemq::commands::DestinationInfo::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<ActiveMQDestination>& activemq::commands::DestinationInfo::getDestination ( ) const [virtual]
virtual Pointer<ActiveMQDestination>& activemq::commands::DestinationInfo::getDestination ( ) [virtual]
virtual unsigned char activemq::commands::DestinationInfo::getOperationType ( ) const [virtual]
virtual long long activemq::commands::DestinationInfo::getTimeout ( ) const [virtual]
virtual void activemq::commands::DestinationInfo::setBrokerPath ( const std::vector< decaf::lang::Pointer< BrokerId > > &  brokerPath) [virtual]
virtual void activemq::commands::DestinationInfo::setConnectionId ( const Pointer< ConnectionId > &  connectionId) [virtual]
virtual void activemq::commands::DestinationInfo::setDestination ( const Pointer< ActiveMQDestination > &  destination) [virtual]
virtual void activemq::commands::DestinationInfo::setOperationType ( unsigned char  operationType) [virtual]
virtual void activemq::commands::DestinationInfo::setTimeout ( long long  timeout) [virtual]
virtual std::string activemq::commands::DestinationInfo::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::DestinationInfo::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


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