org::xmlBlaster::util::qos::storage::CbQueueProperty Class Reference

Inheritance diagram for org::xmlBlaster::util::qos::storage::CbQueueProperty:

[legend]Collaboration diagram for org::xmlBlaster::util::qos::storage::CbQueueProperty:

[legend]List of all members.

Public Member Functions
	CbQueueProperty (org::xmlBlaster::util::Global &global, std::string &relating, std::string &nodeId)
	Parameters: relating  To what is this queue related: Constants.RELATING_CALLBACK | Constants.RELATING_SUBJECT
	CbQueueProperty (QueuePropertyBase &prop)
CbQueueProperty &	operator= (QueuePropertyBase &prop)
std::string	getSettings ()
	Show some important settings for logging.
void	setRelating (std::string &relating)
	Parameters: relating  To what is this queue related: Constants.RELATING_CALLBACK | Constants.RELATING_SUBJECT
bool	isSubjectRelated ()
bool	isSessionRelated ()
bool	onOverflowDeadMessage ()
void	setCallbackAddress (org::xmlBlaster::util::qos::address::AddressBaseRef &address)
	Currently only one address is allowed, failover addresses will be implemented in a future version.
void	setCallbackAddresses (AddressVector &addresses)
AddressVector	getCallbackAddresses ()
	Returns: array with size 0 if none available
org::xmlBlaster::util::qos::address::AddressBaseRef	getCurrentCallbackAddress ()
	Returns: a default if none available
Static Public Member Functions
static std::string &	toLowerCase (std::string &ref)
	This method converts a std::string to lowercase.
static std::string	usage ()
	Get a usage string for the connection parameters.

---

Detailed Description

Definition at line 31 of file CbQueueProperty.h.

---

Constructor & Destructor Documentation

org::xmlBlaster::util::qos::storage::CbQueueProperty::CbQueueProperty	(	org::xmlBlaster::util::Global &	global,
		std::string &	relating,
		std::string &	nodeId
	)

Parameters:

relating

To what is this queue related: Constants.RELATING_CALLBACK | Constants.RELATING_SUBJECT

Parameters:

nodeId

If not null, the command line properties will look for prop[nodeId] as well, e.g. -queue/maxEntries and -queue/maxEntries[heron] will be searched

org::xmlBlaster::util::qos::storage::CbQueueProperty::CbQueueProperty

(

QueuePropertyBase &

prop

)

Definition at line 38 of file CbQueueProperty.cpp.

---

Member Function Documentation

CbQueueProperty & org::xmlBlaster::util::qos::storage::CbQueueProperty::operator=

(

QueuePropertyBase &

prop

)

Reimplemented from org::xmlBlaster::util::qos::storage::QueuePropertyBase.

Definition at line 44 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::copy().

string org::xmlBlaster::util::qos::storage::CbQueueProperty::getSettings

(

)

Show some important settings for logging.

Definition at line 53 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::addressArr_, getCurrentCallbackAddress(), org::xmlBlaster::util::qos::storage::QueuePropertyBase::getMaxEntries(), org::xmlBlaster::util::qos::storage::QueuePropertyBase::getOnFailure(), org::xmlBlaster::util::qos::storage::QueuePropertyBase::getOnOverflow(), org::xmlBlaster::util::qos::storage::QueuePropertyBase::getType(), and org::xmlBlaster::util::lexical_cast().

Referenced by org::xmlBlaster::client::XmlBlasterAccess::createDefaultCbServer().

static std::string& org::xmlBlaster::util::qos::storage::CbQueueProperty::toLowerCase

(

std::string &

ref

)

[static]

This method converts a std::string to lowercase.

Note that the input std::string is modified and a reference to it is returned.

void org::xmlBlaster::util::qos::storage::CbQueueProperty::setRelating

(

std::string &

relating

)

Parameters:

relating

To what is this queue related: Constants.RELATING_CALLBACK | Constants.RELATING_SUBJECT

Reimplemented from org::xmlBlaster::util::qos::storage::QueuePropertyBase.

bool org::xmlBlaster::util::qos::storage::CbQueueProperty::isSubjectRelated

(

)

Definition at line 101 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::getRelating(), and org::xmlBlaster::util::Constants::RELATING_SUBJECT.

bool org::xmlBlaster::util::qos::storage::CbQueueProperty::isSessionRelated

(

)

Definition at line 106 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::getRelating(), and org::xmlBlaster::util::Constants::RELATING_CALLBACK.

bool org::xmlBlaster::util::qos::storage::CbQueueProperty::onOverflowDeadMessage

(

)

Definition at line 111 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::getOnOverflow(), and org::xmlBlaster::util::Constants::ONOVERFLOW_DEADMESSAGE.

void org::xmlBlaster::util::qos::storage::CbQueueProperty::setCallbackAddress

(

org::xmlBlaster::util::qos::address::AddressBaseRef &

address

)

Currently only one address is allowed, failover addresses will be implemented in a future version.

Definition at line 122 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::addressArr_.

Referenced by org::xmlBlaster::util::qos::ConnectQosData::addCbAddress(), and getCurrentCallbackAddress().

void org::xmlBlaster::util::qos::storage::CbQueueProperty::setCallbackAddresses

(

AddressVector &

addresses

)

Definition at line 131 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::addressArr_.

AddressVector org::xmlBlaster::util::qos::storage::CbQueueProperty::getCallbackAddresses

(

)

Returns:

array with size 0 if none available

Definition at line 139 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::addressArr_.

AddressBaseRef org::xmlBlaster::util::qos::storage::CbQueueProperty::getCurrentCallbackAddress

(

)

Returns:

a default if none available

Definition at line 147 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::addressArr_, org::xmlBlaster::util::qos::storage::QueuePropertyBase::global_, and setCallbackAddress().

Referenced by org::xmlBlaster::client::protocol::socket::SocketDriver::connect(), org::xmlBlaster::client::XmlBlasterAccess::createDefaultCbServer(), org::xmlBlaster::client::XmlBlasterAccess::disconnect(), org::xmlBlaster::util::qos::ConnectQosData::getCbAddress(), getSettings(), and org::xmlBlaster::client::XmlBlasterAccess::leaveServer().

string org::xmlBlaster::util::qos::storage::CbQueueProperty::usage

(

)

[static]

Get a usage string for the connection parameters.

Definition at line 158 of file CbQueueProperty.cpp.

References org::xmlBlaster::util::qos::storage::DEFAULT_bytesDefault, org::xmlBlaster::util::qos::storage::DEFAULT_maxEntriesDefault, org::xmlBlaster::util::qos::storage::DEFAULT_type, and org::xmlBlaster::util::lexical_cast().

Referenced by org::xmlBlaster::util::Global::usage().

---

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

• util/qos/storage/CbQueueProperty.h
• util/qos/storage/CbQueueProperty.cpp