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 ConnectionInfo *	cloneDataStructure () 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< RemoveInfo >	createRemoveCommand () 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 bool	isConnectionInfo () const
virtual Pointer< Command >	visit (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_CONNECTIONINFO = 3
Protected Attributes
Pointer< ConnectionId >	connectionId
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

---

Constructor & Destructor Documentation

activemq::commands::ConnectionInfo::ConnectionInfo

(

)

virtual activemq::commands::ConnectionInfo::~ConnectionInfo

(

)

[virtual]

---

Member Function Documentation

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.

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.

Pointer<RemoveInfo> activemq::commands::ConnectionInfo::createRemoveCommand

(

)

const

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.

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

(

)

const [virtual]

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

(

)

[virtual]

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

(

)

const [virtual]

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

(

)

[virtual]

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

(

)

[virtual]

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

(

)

const [virtual]

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.

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

(

)

const [virtual]

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

(

)

[virtual]

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

(

)

const [virtual]

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

(

)

[virtual]

virtual bool activemq::commands::ConnectionInfo::isBrokerMasterConnector

(

)

const [virtual]

virtual bool activemq::commands::ConnectionInfo::isClientMaster

(

)

const [virtual]

virtual bool activemq::commands::ConnectionInfo::isConnectionInfo

(

)

const [inline, virtual]

Returns:

an answer of true to the isConnectionInfo() query.

Reimplemented from activemq::commands::BaseCommand.

virtual bool activemq::commands::ConnectionInfo::isFailoverReconnect

(

)

const [virtual]

virtual bool activemq::commands::ConnectionInfo::isFaultTolerant

(

)

const [virtual]

virtual bool activemq::commands::ConnectionInfo::isManageable

(

)

const [virtual]

virtual void activemq::commands::ConnectionInfo::setBrokerMasterConnector

(

bool

brokerMasterConnector

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setBrokerPath

(

const std::vector< decaf::lang::Pointer< BrokerId > > &

brokerPath

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setClientId

(

const std::string &

clientId

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setClientMaster

(

bool

clientMaster

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setConnectionId

(

const Pointer< ConnectionId > &

connectionId

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setFailoverReconnect

(

bool

failoverReconnect

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setFaultTolerant

(

bool

faultTolerant

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setManageable

(

bool

manageable

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setPassword

(

const std::string &

password

)

[virtual]

virtual void activemq::commands::ConnectionInfo::setUserName

(

const std::string &

userName

)

[virtual]

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.

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

bool activemq::commands::ConnectionInfo::brokerMasterConnector [protected]

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

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

bool activemq::commands::ConnectionInfo::clientMaster [protected]

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

bool activemq::commands::ConnectionInfo::failoverReconnect [protected]

bool activemq::commands::ConnectionInfo::faultTolerant [protected]

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

bool activemq::commands::ConnectionInfo::manageable [protected]

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

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

---

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

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