activemq-cpp-3.9.5
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 ConnectionControlcloneDataStructure () 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 const std::vector< unsigned char > & getToken () const
 
virtual std::vector< unsigned char > & getToken ()
 
virtual void setToken (const std::vector< unsigned char > &token)
 
virtual bool isConnectionControl () 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 isConnectionError () const
 
virtual bool isConnectionInfo () 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_CONNECTIONCONTROL = 18
 

Protected Attributes

bool close
 
bool exit
 
bool faultTolerant
 
bool resume
 
bool suspend
 
std::string connectedBrokers
 
std::string reconnectTo
 
bool rebalanceConnection
 
std::vector< unsigned char > token
 

Constructor & Destructor Documentation

◆ ConnectionControl()

activemq::commands::ConnectionControl::ConnectionControl ( )

◆ ~ConnectionControl()

virtual activemq::commands::ConnectionControl::~ConnectionControl ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

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.

◆ copyDataStructure()

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.

◆ equals()

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.

◆ getConnectedBrokers() [1/2]

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

◆ getConnectedBrokers() [2/2]

virtual const std::string & activemq::commands::ConnectionControl::getConnectedBrokers ( ) const
virtual

◆ getDataStructureType()

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.

◆ getReconnectTo() [1/2]

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

◆ getReconnectTo() [2/2]

virtual const std::string & activemq::commands::ConnectionControl::getReconnectTo ( ) const
virtual

◆ getToken() [1/2]

virtual std::vector< unsigned char > & activemq::commands::ConnectionControl::getToken ( )
virtual

◆ getToken() [2/2]

virtual const std::vector< unsigned char > & activemq::commands::ConnectionControl::getToken ( ) const
virtual

◆ isClose()

virtual bool activemq::commands::ConnectionControl::isClose ( ) const
virtual

◆ isConnectionControl()

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

Reimplemented from activemq::commands::BaseCommand.

◆ isExit()

virtual bool activemq::commands::ConnectionControl::isExit ( ) const
virtual

◆ isFaultTolerant()

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

◆ isRebalanceConnection()

virtual bool activemq::commands::ConnectionControl::isRebalanceConnection ( ) const
virtual

◆ isResume()

virtual bool activemq::commands::ConnectionControl::isResume ( ) const
virtual

◆ isSuspend()

virtual bool activemq::commands::ConnectionControl::isSuspend ( ) const
virtual

◆ setClose()

virtual void activemq::commands::ConnectionControl::setClose ( bool close)
virtual

References close.

◆ setConnectedBrokers()

virtual void activemq::commands::ConnectionControl::setConnectedBrokers ( const std::string & connectedBrokers)
virtual

References connectedBrokers.

◆ setExit()

virtual void activemq::commands::ConnectionControl::setExit ( bool exit)
virtual

References exit.

◆ setFaultTolerant()

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

References faultTolerant.

◆ setRebalanceConnection()

virtual void activemq::commands::ConnectionControl::setRebalanceConnection ( bool rebalanceConnection)
virtual

References rebalanceConnection.

◆ setReconnectTo()

virtual void activemq::commands::ConnectionControl::setReconnectTo ( const std::string & reconnectTo)
virtual

References reconnectTo.

◆ setResume()

virtual void activemq::commands::ConnectionControl::setResume ( bool resume)
virtual

References resume.

◆ setSuspend()

virtual void activemq::commands::ConnectionControl::setSuspend ( bool suspend)
virtual

References suspend.

◆ setToken()

virtual void activemq::commands::ConnectionControl::setToken ( const std::vector< unsigned char > & token)
virtual

References token.

◆ toString()

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.

◆ visit()

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

◆ close

bool activemq::commands::ConnectionControl::close
protected

Referenced by setClose().

◆ connectedBrokers

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

Referenced by setConnectedBrokers().

◆ exit

bool activemq::commands::ConnectionControl::exit
protected

Referenced by setExit().

◆ faultTolerant

bool activemq::commands::ConnectionControl::faultTolerant
protected

Referenced by setFaultTolerant().

◆ ID_CONNECTIONCONTROL

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

◆ rebalanceConnection

bool activemq::commands::ConnectionControl::rebalanceConnection
protected

Referenced by setRebalanceConnection().

◆ reconnectTo

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

Referenced by setReconnectTo().

◆ resume

bool activemq::commands::ConnectionControl::resume
protected

Referenced by setResume().

◆ suspend

bool activemq::commands::ConnectionControl::suspend
protected

Referenced by setSuspend().

◆ token

std::vector<unsigned char> activemq::commands::ConnectionControl::token
protected

Referenced by setToken().


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