activemq::commands::ConnectionControl Class Reference

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

Inheritance diagram for activemq::commands::ConnectionControl:

Public Member Functions
	ConnectionControl ()
virtual	~ConnectionControl ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual ConnectionControl *	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 bool	isClose () const
virtual void	setClose (bool close)
virtual bool	isExit () const
virtual void	setExit (bool exit)
virtual bool	isFaultTolerant () const
virtual void	setFaultTolerant (bool faultTolerant)
virtual bool	isResume () const
virtual void	setResume (bool resume)
virtual bool	isSuspend () const
virtual void	setSuspend (bool suspend)
virtual const std::string &	getConnectedBrokers () const
virtual std::string &	getConnectedBrokers ()
virtual void	setConnectedBrokers (const std::string &connectedBrokers)
virtual const std::string &	getReconnectTo () const
virtual std::string &	getReconnectTo ()
virtual void	setReconnectTo (const std::string &reconnectTo)
virtual bool	isRebalanceConnection () const
virtual void	setRebalanceConnection (bool rebalanceConnection)
virtual bool	isConnectionControl () 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_CONNECTIONCONTROL = 18
Protected Attributes
bool	close
bool	exit
bool	faultTolerant
bool	resume
bool	suspend
std::string	connectedBrokers
std::string	reconnectTo
bool	rebalanceConnection

---

Constructor & Destructor Documentation

activemq::commands::ConnectionControl::ConnectionControl

(

)

virtual activemq::commands::ConnectionControl::~ConnectionControl

(

)

[virtual]

---

Member Function Documentation

virtual ConnectionControl* activemq::commands::ConnectionControl::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::ConnectionControl::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::ConnectionControl::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::string& activemq::commands::ConnectionControl::getConnectedBrokers

(

)

const [virtual]

virtual std::string& activemq::commands::ConnectionControl::getConnectedBrokers

(

)

[virtual]

virtual unsigned char activemq::commands::ConnectionControl::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::ConnectionControl::getReconnectTo

(

)

const [virtual]

virtual std::string& activemq::commands::ConnectionControl::getReconnectTo

(

)

[virtual]

virtual bool activemq::commands::ConnectionControl::isClose

(

)

const [virtual]

virtual bool activemq::commands::ConnectionControl::isConnectionControl

(

)

const [inline, virtual]

Returns:

an answer of true to the isConnectionControl() query.

Reimplemented from activemq::commands::BaseCommand.

virtual bool activemq::commands::ConnectionControl::isExit

(

)

const [virtual]

virtual bool activemq::commands::ConnectionControl::isFaultTolerant

(

)

const [virtual]

virtual bool activemq::commands::ConnectionControl::isRebalanceConnection

(

)

const [virtual]

virtual bool activemq::commands::ConnectionControl::isResume

(

)

const [virtual]

virtual bool activemq::commands::ConnectionControl::isSuspend

(

)

const [virtual]

virtual void activemq::commands::ConnectionControl::setClose

(

bool

close

)

[virtual]

virtual void activemq::commands::ConnectionControl::setConnectedBrokers

(

const std::string &

connectedBrokers

)

[virtual]

virtual void activemq::commands::ConnectionControl::setExit

(

bool

exit

)

[virtual]

virtual void activemq::commands::ConnectionControl::setFaultTolerant

(

bool

faultTolerant

)

[virtual]

virtual void activemq::commands::ConnectionControl::setRebalanceConnection

(

bool

rebalanceConnection

)

[virtual]

virtual void activemq::commands::ConnectionControl::setReconnectTo

(

const std::string &

reconnectTo

)

[virtual]

virtual void activemq::commands::ConnectionControl::setResume

(

bool

resume

)

[virtual]

virtual void activemq::commands::ConnectionControl::setSuspend

(

bool

suspend

)

[virtual]

virtual std::string activemq::commands::ConnectionControl::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::ConnectionControl::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::ConnectionControl::close [protected]

std::string activemq::commands::ConnectionControl::connectedBrokers [protected]

bool activemq::commands::ConnectionControl::exit [protected]

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

const unsigned char activemq::commands::ConnectionControl::ID_CONNECTIONCONTROL = 18 [static]

bool activemq::commands::ConnectionControl::rebalanceConnection [protected]

std::string activemq::commands::ConnectionControl::reconnectTo [protected]

bool activemq::commands::ConnectionControl::resume [protected]

bool activemq::commands::ConnectionControl::suspend [protected]

---

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

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