org::xmlBlaster::client::qos::SubscribeReturnQos Class Reference

Collaboration diagram for org::xmlBlaster::client::qos::SubscribeReturnQos:

[legend]List of all members.

Public Member Functions
	SubscribeReturnQos (org::xmlBlaster::util::Global &global, const org::xmlBlaster::util::qos::StatusQosData &data)
	Constructs the specialized quality of service object for status informations, e.g.
	SubscribeReturnQos (org::xmlBlaster::util::Global &global)
	SubscribeReturnQos (const SubscribeReturnQos &data)
SubscribeReturnQos	operator= (const SubscribeReturnQos &data)
std::string	getState () const
	Access state of message on update().
std::string	getStateInfo () const
	Access state of message on update().
std::string	getSubscriptionId () const
	Access key oid.
bool	isPersistent () const
	gets the subscription status: persistent (true) or not persistent (false).
bool	isFakedReturn () const
	Allows to check if the subscription request was queued on client side.
std::string	toXml (const std::string &extraOffset="") const
	Dump state of this object into a XML ASCII std::string.
org::xmlBlaster::util::qos::StatusQosData &	getData ()

---

Detailed Description

Definition at line 31 of file SubscribeReturnQos.h.

---

Constructor & Destructor Documentation

org::xmlBlaster::client::qos::SubscribeReturnQos::SubscribeReturnQos	(	org::xmlBlaster::util::Global &	global,
		const org::xmlBlaster::util::qos::StatusQosData &	data
	)

Constructs the specialized quality of service object for status informations, e.g.

for a return of a subscribe() call

The state defaults to Constants::STATE_OK

Parameters:

	global	The stack
	data	The data object

org::xmlBlaster::client::qos::SubscribeReturnQos::SubscribeReturnQos

(

org::xmlBlaster::util::Global &

global

)

Definition at line 40 of file SubscribeReturnQos.cpp.

org::xmlBlaster::client::qos::SubscribeReturnQos::SubscribeReturnQos

(

const SubscribeReturnQos &

data

)

---

Member Function Documentation

SubscribeReturnQos org::xmlBlaster::client::qos::SubscribeReturnQos::operator=

(

const SubscribeReturnQos &

data

)

std::string org::xmlBlaster::client::qos::SubscribeReturnQos::getState

(

)

const

Access state of message on update().

Returns:

"OK", "ERROR" etc. See Constants::java

std::string org::xmlBlaster::client::qos::SubscribeReturnQos::getStateInfo

(

)

const

Access state of message on update().

Returns:

The human readable info text

std::string org::xmlBlaster::client::qos::SubscribeReturnQos::getSubscriptionId

(

)

const

Access key oid.

Returns:

The unique identifier of a message

Referenced by MultiConnectDemo::execute(), org::xmlBlaster::client::XmlBlasterAccess::subscribe(), SubscribeDemo::subscribe(), org::xmlBlaster::test::TestConnect::testPubSub(), org::xmlBlaster::test::TestSub::testSubscribeSpecificCallback(), and org::xmlBlaster::test::TestSub::testSubscribeXPath().

bool org::xmlBlaster::client::qos::SubscribeReturnQos::isPersistent

(

)

const

gets the subscription status: persistent (true) or not persistent (false).

If it is true it means that the subscription has implicitly made the associated session persistent and both are surviving a server crash.

bool org::xmlBlaster::client::qos::SubscribeReturnQos::isFakedReturn

(

)

const

Allows to check if the subscription request was queued on client side.

If a subscribe is queued the return subscriptionId is generated on client side and may on later connect not force to be the same on server side. TODO: Enforce identical client + server side generation: 1. If pubSessionId>0: <sessionName>-[EXACT:|XPATH:|DOMAIN:][topicOid|queryString] 2. For none fail save clients any unique Id will do

Returns:

true if subscribe is queued

std::string org::xmlBlaster::client::qos::SubscribeReturnQos::toXml

(

const std::string &

extraOffset = ""

)

const

Dump state of this object into a XML ASCII std::string.

Parameters:

extraOffset

indenting of tags for nice output

Returns:

internal state of the status as a XML ASCII std::string

Referenced by TestEmptyContent::execute(), HelloWorld2::execute(), org::xmlBlaster::test::TestFailsafe::setUp(), and SubscribeDemo::subscribe().

StatusQosData & org::xmlBlaster::client::qos::SubscribeReturnQos::getData

(

)

Definition at line 76 of file SubscribeReturnQos.cpp.

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::queueSubscribe(), and org::xmlBlaster::util::queue::SubscribeQueueEntry::send().

---

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

• client/qos/SubscribeReturnQos.h
• client/qos/SubscribeReturnQos.cpp