activemq-cpp-3.9.5
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 BrokerInfocloneDataStructure () 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< 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 isControlCommand () const
 
virtual bool isConnectionControl () 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_BROKERINFO = 2
 

Protected Attributes

Pointer< BrokerIdbrokerId
 
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

◆ BrokerInfo()

activemq::commands::BrokerInfo::BrokerInfo ( )

◆ ~BrokerInfo()

virtual activemq::commands::BrokerInfo::~BrokerInfo ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

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.

◆ copyDataStructure()

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.

◆ equals()

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.

◆ getBrokerId() [1/2]

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

◆ getBrokerId() [2/2]

virtual const Pointer< BrokerId > & activemq::commands::BrokerInfo::getBrokerId ( ) const
virtual

◆ getBrokerName() [1/2]

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

◆ getBrokerName() [2/2]

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

◆ getBrokerUploadUrl() [1/2]

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

◆ getBrokerUploadUrl() [2/2]

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

◆ getBrokerURL() [1/2]

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

◆ getBrokerURL() [2/2]

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

◆ getConnectionId()

virtual long long activemq::commands::BrokerInfo::getConnectionId ( ) const
virtual

◆ getDataStructureType()

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.

◆ getNetworkProperties() [1/2]

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

◆ getNetworkProperties() [2/2]

virtual const std::string & activemq::commands::BrokerInfo::getNetworkProperties ( ) const
virtual

◆ getPeerBrokerInfos() [1/2]

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

◆ getPeerBrokerInfos() [2/2]

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

◆ isBrokerInfo()

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

Reimplemented from activemq::commands::BaseCommand.

◆ isDuplexConnection()

virtual bool activemq::commands::BrokerInfo::isDuplexConnection ( ) const
virtual

◆ isFaultTolerantConfiguration()

virtual bool activemq::commands::BrokerInfo::isFaultTolerantConfiguration ( ) const
virtual

◆ isMasterBroker()

virtual bool activemq::commands::BrokerInfo::isMasterBroker ( ) const
virtual

◆ isNetworkConnection()

virtual bool activemq::commands::BrokerInfo::isNetworkConnection ( ) const
virtual

◆ isSlaveBroker()

virtual bool activemq::commands::BrokerInfo::isSlaveBroker ( ) const
virtual

◆ setBrokerId()

virtual void activemq::commands::BrokerInfo::setBrokerId ( const Pointer< BrokerId > & brokerId)
virtual

References brokerId.

◆ setBrokerName()

virtual void activemq::commands::BrokerInfo::setBrokerName ( const std::string & brokerName)
virtual

References brokerName.

◆ setBrokerUploadUrl()

virtual void activemq::commands::BrokerInfo::setBrokerUploadUrl ( const std::string & brokerUploadUrl)
virtual

References brokerUploadUrl.

◆ setBrokerURL()

virtual void activemq::commands::BrokerInfo::setBrokerURL ( const std::string & brokerURL)
virtual

References brokerURL.

◆ setConnectionId()

virtual void activemq::commands::BrokerInfo::setConnectionId ( long long connectionId)
virtual

References connectionId.

◆ setDuplexConnection()

virtual void activemq::commands::BrokerInfo::setDuplexConnection ( bool duplexConnection)
virtual

References duplexConnection.

◆ setFaultTolerantConfiguration()

virtual void activemq::commands::BrokerInfo::setFaultTolerantConfiguration ( bool faultTolerantConfiguration)
virtual

◆ setMasterBroker()

virtual void activemq::commands::BrokerInfo::setMasterBroker ( bool masterBroker)
virtual

References masterBroker.

◆ setNetworkConnection()

virtual void activemq::commands::BrokerInfo::setNetworkConnection ( bool networkConnection)
virtual

References networkConnection.

◆ setNetworkProperties()

virtual void activemq::commands::BrokerInfo::setNetworkProperties ( const std::string & networkProperties)
virtual

References networkProperties.

◆ setPeerBrokerInfos()

virtual void activemq::commands::BrokerInfo::setPeerBrokerInfos ( const std::vector< decaf::lang::Pointer< BrokerInfo > > & peerBrokerInfos)
virtual

References peerBrokerInfos.

◆ setSlaveBroker()

virtual void activemq::commands::BrokerInfo::setSlaveBroker ( bool slaveBroker)
virtual

References slaveBroker.

◆ toString()

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.

◆ visit()

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

◆ brokerId

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

Referenced by setBrokerId().

◆ brokerName

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

Referenced by setBrokerName().

◆ brokerUploadUrl

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

Referenced by setBrokerUploadUrl().

◆ brokerURL

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

Referenced by setBrokerURL().

◆ connectionId

long long activemq::commands::BrokerInfo::connectionId
protected

Referenced by setConnectionId().

◆ duplexConnection

bool activemq::commands::BrokerInfo::duplexConnection
protected

Referenced by setDuplexConnection().

◆ faultTolerantConfiguration

bool activemq::commands::BrokerInfo::faultTolerantConfiguration
protected

◆ ID_BROKERINFO

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

◆ masterBroker

bool activemq::commands::BrokerInfo::masterBroker
protected

Referenced by setMasterBroker().

◆ networkConnection

bool activemq::commands::BrokerInfo::networkConnection
protected

Referenced by setNetworkConnection().

◆ networkProperties

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

Referenced by setNetworkProperties().

◆ peerBrokerInfos

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

Referenced by setPeerBrokerInfos().

◆ slaveBroker

bool activemq::commands::BrokerInfo::slaveBroker
protected

Referenced by setSlaveBroker().


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