activemq-cpp-3.9.5
activemq::commands::ConnectionInfo Class Reference

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

Inheritance diagram for activemq::commands::ConnectionInfo:

Public Member Functions

 ConnectionInfo ()
 
virtual ~ConnectionInfo ()
 
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
 
virtual ConnectionInfocloneDataStructure () 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.
 
Pointer< RemoveInfocreateRemoveCommand () const
 
virtual const Pointer< ConnectionId > & getConnectionId () const
 
virtual Pointer< ConnectionId > & getConnectionId ()
 
virtual void setConnectionId (const Pointer< ConnectionId > &connectionId)
 
virtual const std::string & getClientId () const
 
virtual std::string & getClientId ()
 
virtual void setClientId (const std::string &clientId)
 
virtual const std::string & getPassword () const
 
virtual std::string & getPassword ()
 
virtual void setPassword (const std::string &password)
 
virtual const std::string & getUserName () const
 
virtual std::string & getUserName ()
 
virtual void setUserName (const std::string &userName)
 
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 bool isBrokerMasterConnector () const
 
virtual void setBrokerMasterConnector (bool brokerMasterConnector)
 
virtual bool isManageable () const
 
virtual void setManageable (bool manageable)
 
virtual bool isClientMaster () const
 
virtual void setClientMaster (bool clientMaster)
 
virtual bool isFaultTolerant () const
 
virtual void setFaultTolerant (bool faultTolerant)
 
virtual bool isFailoverReconnect () const
 
virtual void setFailoverReconnect (bool failoverReconnect)
 
virtual const std::string & getClientIp () const
 
virtual std::string & getClientIp ()
 
virtual void setClientIp (const std::string &clientIp)
 
virtual bool isConnectionInfo () const
 
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.
 
- Public Member Functions inherited from activemq::commands::BaseCommand
 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 bool isBrokerInfo () const
 
virtual bool isControlCommand () const
 
virtual bool isConnectionControl () const
 
virtual bool isConnectionError () const
 
virtual bool isConsumerInfo () const
 
virtual bool isConsumerControl () const
 
virtual bool isDestinationInfo () const
 
virtual bool isFlushCommand () const
 
virtual bool isMessage () const
 
virtual bool isMessageAck () const
 
virtual bool isMessagePull () 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 isReplayCommand () const
 
virtual bool isSessionInfo () const
 
virtual bool isShutdownInfo () const
 
virtual bool isTransactionInfo () const
 
virtual bool isWireFormatInfo () const
 
- Public Member Functions inherited from activemq::commands::Command
virtual ~Command ()
 
- 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 ()
 
- 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.
 

Static Public Attributes

static const unsigned char ID_CONNECTIONINFO = 3
 

Protected Attributes

Pointer< ConnectionIdconnectionId
 
std::string clientId
 
std::string password
 
std::string userName
 
std::vector< decaf::lang::Pointer< BrokerId > > brokerPath
 
bool brokerMasterConnector
 
bool manageable
 
bool clientMaster
 
bool faultTolerant
 
bool failoverReconnect
 
std::string clientIp
 

Constructor & Destructor Documentation

◆ ConnectionInfo()

activemq::commands::ConnectionInfo::ConnectionInfo ( )

◆ ~ConnectionInfo()

virtual activemq::commands::ConnectionInfo::~ConnectionInfo ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

virtual ConnectionInfo * activemq::commands::ConnectionInfo::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.

◆ copyDataStructure()

virtual void activemq::commands::ConnectionInfo::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.

◆ createRemoveCommand()

Pointer< RemoveInfo > activemq::commands::ConnectionInfo::createRemoveCommand ( ) const

◆ equals()

virtual bool activemq::commands::ConnectionInfo::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.

◆ getBrokerPath() [1/2]

virtual std::vector< decaf::lang::Pointer< BrokerId > > & activemq::commands::ConnectionInfo::getBrokerPath ( )
virtual

◆ getBrokerPath() [2/2]

virtual const std::vector< decaf::lang::Pointer< BrokerId > > & activemq::commands::ConnectionInfo::getBrokerPath ( ) const
virtual

◆ getClientId() [1/2]

virtual std::string & activemq::commands::ConnectionInfo::getClientId ( )
virtual

◆ getClientId() [2/2]

virtual const std::string & activemq::commands::ConnectionInfo::getClientId ( ) const
virtual

◆ getClientIp() [1/2]

virtual std::string & activemq::commands::ConnectionInfo::getClientIp ( )
virtual

◆ getClientIp() [2/2]

virtual const std::string & activemq::commands::ConnectionInfo::getClientIp ( ) const
virtual

◆ getConnectionId() [1/2]

virtual Pointer< ConnectionId > & activemq::commands::ConnectionInfo::getConnectionId ( )
virtual

◆ getConnectionId() [2/2]

virtual const Pointer< ConnectionId > & activemq::commands::ConnectionInfo::getConnectionId ( ) const
virtual

◆ getDataStructureType()

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

Get the DataStructure Type as defined in CommandTypes.h.

Returns
The type of the data structure

Implements activemq::commands::DataStructure.

◆ getPassword() [1/2]

virtual std::string & activemq::commands::ConnectionInfo::getPassword ( )
virtual

◆ getPassword() [2/2]

virtual const std::string & activemq::commands::ConnectionInfo::getPassword ( ) const
virtual

◆ getUserName() [1/2]

virtual std::string & activemq::commands::ConnectionInfo::getUserName ( )
virtual

◆ getUserName() [2/2]

virtual const std::string & activemq::commands::ConnectionInfo::getUserName ( ) const
virtual

◆ isBrokerMasterConnector()

virtual bool activemq::commands::ConnectionInfo::isBrokerMasterConnector ( ) const
virtual

◆ isClientMaster()

virtual bool activemq::commands::ConnectionInfo::isClientMaster ( ) const
virtual

◆ isConnectionInfo()

virtual bool activemq::commands::ConnectionInfo::isConnectionInfo ( ) const
inlinevirtual
Returns
an answer of true to the isConnectionInfo() query.

Reimplemented from activemq::commands::BaseCommand.

◆ isFailoverReconnect()

virtual bool activemq::commands::ConnectionInfo::isFailoverReconnect ( ) const
virtual

◆ isFaultTolerant()

virtual bool activemq::commands::ConnectionInfo::isFaultTolerant ( ) const
virtual

◆ isManageable()

virtual bool activemq::commands::ConnectionInfo::isManageable ( ) const
virtual

◆ setBrokerMasterConnector()

virtual void activemq::commands::ConnectionInfo::setBrokerMasterConnector ( bool brokerMasterConnector)
virtual

References brokerMasterConnector.

◆ setBrokerPath()

virtual void activemq::commands::ConnectionInfo::setBrokerPath ( const std::vector< decaf::lang::Pointer< BrokerId > > & brokerPath)
virtual

References brokerPath.

◆ setClientId()

virtual void activemq::commands::ConnectionInfo::setClientId ( const std::string & clientId)
virtual

References clientId.

◆ setClientIp()

virtual void activemq::commands::ConnectionInfo::setClientIp ( const std::string & clientIp)
virtual

References clientIp.

◆ setClientMaster()

virtual void activemq::commands::ConnectionInfo::setClientMaster ( bool clientMaster)
virtual

References clientMaster.

◆ setConnectionId()

virtual void activemq::commands::ConnectionInfo::setConnectionId ( const Pointer< ConnectionId > & connectionId)
virtual

References connectionId.

◆ setFailoverReconnect()

virtual void activemq::commands::ConnectionInfo::setFailoverReconnect ( bool failoverReconnect)
virtual

References failoverReconnect.

◆ setFaultTolerant()

virtual void activemq::commands::ConnectionInfo::setFaultTolerant ( bool faultTolerant)
virtual

References faultTolerant.

◆ setManageable()

virtual void activemq::commands::ConnectionInfo::setManageable ( bool manageable)
virtual

References manageable.

◆ setPassword()

virtual void activemq::commands::ConnectionInfo::setPassword ( const std::string & password)
virtual

References password.

◆ setUserName()

virtual void activemq::commands::ConnectionInfo::setUserName ( const std::string & userName)
virtual

References userName.

◆ toString()

virtual std::string activemq::commands::ConnectionInfo::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.

◆ visit()

virtual Pointer< Command > activemq::commands::ConnectionInfo::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

◆ brokerMasterConnector

bool activemq::commands::ConnectionInfo::brokerMasterConnector
protected

◆ brokerPath

std::vector< decaf::lang::Pointer<BrokerId> > activemq::commands::ConnectionInfo::brokerPath
protected

Referenced by setBrokerPath().

◆ clientId

std::string activemq::commands::ConnectionInfo::clientId
protected

Referenced by setClientId().

◆ clientIp

std::string activemq::commands::ConnectionInfo::clientIp
protected

Referenced by setClientIp().

◆ clientMaster

bool activemq::commands::ConnectionInfo::clientMaster
protected

Referenced by setClientMaster().

◆ connectionId

Pointer<ConnectionId> activemq::commands::ConnectionInfo::connectionId
protected

Referenced by setConnectionId().

◆ failoverReconnect

bool activemq::commands::ConnectionInfo::failoverReconnect
protected

Referenced by setFailoverReconnect().

◆ faultTolerant

bool activemq::commands::ConnectionInfo::faultTolerant
protected

Referenced by setFaultTolerant().

◆ ID_CONNECTIONINFO

const unsigned char activemq::commands::ConnectionInfo::ID_CONNECTIONINFO = 3
static

◆ manageable

bool activemq::commands::ConnectionInfo::manageable
protected

Referenced by setManageable().

◆ password

std::string activemq::commands::ConnectionInfo::password
protected

Referenced by setPassword().

◆ userName

std::string activemq::commands::ConnectionInfo::userName
protected

Referenced by setUserName().


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