activemq::commands::BrokerInfo Class Reference

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

Inheritance diagram for activemq::commands::BrokerInfo:

Public Member Functions
	BrokerInfo ()
virtual	~BrokerInfo ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual BrokerInfo *	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.
virtual const Pointer< BrokerId > &	getBrokerId () const
virtual Pointer< BrokerId > &	getBrokerId ()
virtual void	setBrokerId (const Pointer< BrokerId > &brokerId)
virtual const std::string &	getBrokerURL () const
virtual std::string &	getBrokerURL ()
virtual void	setBrokerURL (const std::string &brokerURL)
virtual const std::vector < decaf::lang::Pointer < BrokerInfo > > &	getPeerBrokerInfos () const
virtual std::vector < decaf::lang::Pointer < BrokerInfo > > &	getPeerBrokerInfos ()
virtual void	setPeerBrokerInfos (const std::vector< decaf::lang::Pointer< BrokerInfo > > &peerBrokerInfos)
virtual const std::string &	getBrokerName () const
virtual std::string &	getBrokerName ()
virtual void	setBrokerName (const std::string &brokerName)
virtual bool	isSlaveBroker () const
virtual void	setSlaveBroker (bool slaveBroker)
virtual bool	isMasterBroker () const
virtual void	setMasterBroker (bool masterBroker)
virtual bool	isFaultTolerantConfiguration () const
virtual void	setFaultTolerantConfiguration (bool faultTolerantConfiguration)
virtual bool	isDuplexConnection () const
virtual void	setDuplexConnection (bool duplexConnection)
virtual bool	isNetworkConnection () const
virtual void	setNetworkConnection (bool networkConnection)
virtual long long	getConnectionId () const
virtual void	setConnectionId (long long connectionId)
virtual const std::string &	getBrokerUploadUrl () const
virtual std::string &	getBrokerUploadUrl ()
virtual void	setBrokerUploadUrl (const std::string &brokerUploadUrl)
virtual const std::string &	getNetworkProperties () const
virtual std::string &	getNetworkProperties ()
virtual void	setNetworkProperties (const std::string &networkProperties)
virtual bool	isBrokerInfo () 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_BROKERINFO = 2
Protected Attributes
Pointer< BrokerId >	brokerId
std::string	brokerURL
std::vector < decaf::lang::Pointer < BrokerInfo > >	peerBrokerInfos
std::string	brokerName
bool	slaveBroker
bool	masterBroker
bool	faultTolerantConfiguration
bool	duplexConnection
bool	networkConnection
long long	connectionId
std::string	brokerUploadUrl
std::string	networkProperties

---

Constructor & Destructor Documentation

activemq::commands::BrokerInfo::BrokerInfo

(

)

virtual activemq::commands::BrokerInfo::~BrokerInfo

(

)

[virtual]

---

Member Function Documentation

virtual BrokerInfo* activemq::commands::BrokerInfo::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::BrokerInfo::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::BrokerInfo::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 Pointer<BrokerId>& activemq::commands::BrokerInfo::getBrokerId

(

)

const [virtual]

virtual Pointer<BrokerId>& activemq::commands::BrokerInfo::getBrokerId

(

)

[virtual]

virtual std::string& activemq::commands::BrokerInfo::getBrokerName

(

)

[virtual]

virtual const std::string& activemq::commands::BrokerInfo::getBrokerName

(

)

const [virtual]

virtual const std::string& activemq::commands::BrokerInfo::getBrokerUploadUrl

(

)

const [virtual]

virtual std::string& activemq::commands::BrokerInfo::getBrokerUploadUrl

(

)

[virtual]

virtual const std::string& activemq::commands::BrokerInfo::getBrokerURL

(

)

const [virtual]

virtual std::string& activemq::commands::BrokerInfo::getBrokerURL

(

)

[virtual]

virtual long long activemq::commands::BrokerInfo::getConnectionId

(

)

const [virtual]

virtual unsigned char activemq::commands::BrokerInfo::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::BrokerInfo::getNetworkProperties

(

)

const [virtual]

virtual std::string& activemq::commands::BrokerInfo::getNetworkProperties

(

)

[virtual]

virtual const std::vector< decaf::lang::Pointer<BrokerInfo> >& activemq::commands::BrokerInfo::getPeerBrokerInfos

(

)

const [virtual]

virtual std::vector< decaf::lang::Pointer<BrokerInfo> >& activemq::commands::BrokerInfo::getPeerBrokerInfos

(

)

[virtual]

virtual bool activemq::commands::BrokerInfo::isBrokerInfo

(

)

const [inline, virtual]

Returns:

an answer of true to the isBrokerInfo() query.

Reimplemented from activemq::commands::BaseCommand.

virtual bool activemq::commands::BrokerInfo::isDuplexConnection

(

)

const [virtual]

virtual bool activemq::commands::BrokerInfo::isFaultTolerantConfiguration

(

)

const [virtual]

virtual bool activemq::commands::BrokerInfo::isMasterBroker

(

)

const [virtual]

virtual bool activemq::commands::BrokerInfo::isNetworkConnection

(

)

const [virtual]

virtual bool activemq::commands::BrokerInfo::isSlaveBroker

(

)

const [virtual]

virtual void activemq::commands::BrokerInfo::setBrokerId

(

const Pointer< BrokerId > &

brokerId

)

[virtual]

virtual void activemq::commands::BrokerInfo::setBrokerName

(

const std::string &

brokerName

)

[virtual]

virtual void activemq::commands::BrokerInfo::setBrokerUploadUrl

(

const std::string &

brokerUploadUrl

)

[virtual]

virtual void activemq::commands::BrokerInfo::setBrokerURL

(

const std::string &

brokerURL

)

[virtual]

virtual void activemq::commands::BrokerInfo::setConnectionId

(

long long

connectionId

)

[virtual]

virtual void activemq::commands::BrokerInfo::setDuplexConnection

(

bool

duplexConnection

)

[virtual]

virtual void activemq::commands::BrokerInfo::setFaultTolerantConfiguration

(

bool

faultTolerantConfiguration

)

[virtual]

virtual void activemq::commands::BrokerInfo::setMasterBroker

(

bool

masterBroker

)

[virtual]

virtual void activemq::commands::BrokerInfo::setNetworkConnection

(

bool

networkConnection

)

[virtual]

virtual void activemq::commands::BrokerInfo::setNetworkProperties

(

const std::string &

networkProperties

)

[virtual]

virtual void activemq::commands::BrokerInfo::setPeerBrokerInfos

(

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

peerBrokerInfos

)

[virtual]

virtual void activemq::commands::BrokerInfo::setSlaveBroker

(

bool

slaveBroker

)

[virtual]

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

Pointer<BrokerId> activemq::commands::BrokerInfo::brokerId [protected]

std::string activemq::commands::BrokerInfo::brokerName [protected]

std::string activemq::commands::BrokerInfo::brokerUploadUrl [protected]

std::string activemq::commands::BrokerInfo::brokerURL [protected]

long long activemq::commands::BrokerInfo::connectionId [protected]

bool activemq::commands::BrokerInfo::duplexConnection [protected]

bool activemq::commands::BrokerInfo::faultTolerantConfiguration [protected]

const unsigned char activemq::commands::BrokerInfo::ID_BROKERINFO = 2 [static]

bool activemq::commands::BrokerInfo::masterBroker [protected]

bool activemq::commands::BrokerInfo::networkConnection [protected]

std::string activemq::commands::BrokerInfo::networkProperties [protected]

std::vector< decaf::lang::Pointer<BrokerInfo> > activemq::commands::BrokerInfo::peerBrokerInfos [protected]

bool activemq::commands::BrokerInfo::slaveBroker [protected]

---

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

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