org::xmlBlaster::client::qos::GetReturnQos

org::xmlBlaster::client::qos::GetReturnQos Class Reference

Inheritance diagram for org::xmlBlaster::client::qos::GetReturnQos:

[legend]Collaboration diagram for org::xmlBlaster::client::qos::GetReturnQos:


Public Member Functions
	GetReturnQos (org::xmlBlaster::util::Global &global, org::xmlBlaster::util::qos::MsgQosData &data)
	GetReturnQos (GetReturnQos &data)
GetReturnQos &	operator= (GetReturnQos &)
org::xmlBlaster::util::qos::MsgQosData &	getData ()
bool	isVolatile ()
	Returns: true/false
bool	isPersistent ()
	Returns: true/false
bool	isReadonly ()
	Returns: true/false
org::xmlBlaster::util::SessionNameRef	getSender ()
	Access sender unified naming object.
org::xmlBlaster::util::PriorityEnum	getPriority ()
	Message priority.
long	getRemainingLifeStatic ()
	This is the value delivered in the QoS (as it was calculated by the server on sending) and is NOT dynamically recalculated.
std::string	toXml (std::string &extraOffset="")
	Dump state of this object into a XML ASCII std::string.
std::string	getState ()
	Access state of message on update().
bool	isOk ()
	True if the message is OK on update().
bool	isErased ()
	True if the message was erased by timer or by a client invoking erase().
bool	isTimeout ()
	True if a timeout on this message occurred.
org::xmlBlaster::util::Timestamp	getRcvTimestamp ()
	The approximate receive timestamp (UTC time), when message arrived in requestBroker.publish() method.
org::xmlBlaster::util::qos::RouteVector	getRouteNodes ()
std::string	getRcvTime ()
org::xmlBlaster::util::qos::QosData::ClientPropertyMap &	getClientProperties ()
	Get a map containing all send client properties.
bool	hasClientProperty (std::string &name)
template<typename T_VALUE>
T_VALUE	getClientProperty (std::string &name, T_VALUE &defaultValue)
	Access the value for the given name, if not found returns the defaultValue.
Protected Attributes
std::string	ME
org::xmlBlaster::util::Global &	global_
org::xmlBlaster::util::I_Log &	log_
org::xmlBlaster::util::qos::MsgQosData	data_

Detailed Description

Definition at line 40 of file GetReturnQos.h.

Constructor & Destructor Documentation

org::xmlBlaster::client::qos::GetReturnQos::GetReturnQos	(	org::xmlBlaster::util::Global &	global,
		org::xmlBlaster::util::qos::MsgQosData &	data
	)

Definition at line 18 of file GetReturnQos.cpp.

org::xmlBlaster::client::qos::GetReturnQos::GetReturnQos ( GetReturnQos & data )

Definition at line 23 of file GetReturnQos.cpp.

Member Function Documentation

GetReturnQos & org::xmlBlaster::client::qos::GetReturnQos::operator= ( GetReturnQos & )

Definition at line 28 of file GetReturnQos.cpp.

Referenced by org::xmlBlaster::client::qos::UpdateQos::operator=().

org::xmlBlaster::util::qos::MsgQosData& org::xmlBlaster::client::qos::GetReturnQos::getData ( )

Definition at line 56 of file GetReturnQos.h.

bool org::xmlBlaster::client::qos::GetReturnQos::isVolatile ( )

Returns:: true/false

Definition at line 33 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::MsgQosData::isVolatile().

bool org::xmlBlaster::client::qos::GetReturnQos::isPersistent ( )

Returns:: true/false

Definition at line 38 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::isPersistent().

bool org::xmlBlaster::client::qos::GetReturnQos::isReadonly ( )

Returns:: true/false

Definition at line 43 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::MsgQosData::isReadonly().

SessionNameRef org::xmlBlaster::client::qos::GetReturnQos::getSender ( )

Access sender unified naming object.

Returns:: sessionName of sender or null if not known

Definition at line 48 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::getSender().

Referenced by org::xmlBlaster::test::TestSub::update(), and org::xmlBlaster::client::protocol::corba::DefaultCallback::updateOneway().

PriorityEnum org::xmlBlaster::client::qos::GetReturnQos::getPriority ( )

Message priority.

Returns:: priority 0-9

See also:: org.xmlBlaster.util.def.PriorityEnum

Definition at line 53 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::getPriority().

long org::xmlBlaster::client::qos::GetReturnQos::getRemainingLifeStatic ( )

This is the value delivered in the QoS (as it was calculated by the server on sending) and is NOT dynamically recalculated.

So trust this value only if your client clock is out of date (or not trusted) and if you know the message sending latency is not too big.

Returns:: Milliseconds until message expiration (from now) or -1L if forever if 0L the message is expired

Definition at line 58 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::MsgQosData::getRemainingLifeStatic().

std::string org::xmlBlaster::client::qos::GetReturnQos::toXml ( std::string & extraOffset = "" )

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

Parameters:

extraOffset

indenting of tags for nice output

Returns:: internal state of the message QoS as a XML ASCII std::string

Referenced by org::xmlBlaster::test::TestFailsafe::update(), TestEmptyContent::update(), SubscribeDemo::update(), SpecificCallback::update(), and HelloWorld2::update().

string org::xmlBlaster::client::qos::GetReturnQos::getState ( )

Access state of message on update().

Returns:: OK (Other values are not yet supported)

Definition at line 68 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::getState().

Referenced by org::xmlBlaster::test::TestSub::update(), org::xmlBlaster::test::TestLeaveServer::update(), org::xmlBlaster::test::TestFailsafe::update(), org::xmlBlaster::test::TestCommand::update(), and org::xmlBlaster::test::SpecificCallback::update().

bool org::xmlBlaster::client::qos::GetReturnQos::isOk ( )

True if the message is OK on update().

Reimplemented in org::xmlBlaster::client::qos::UpdateQos.

Definition at line 73 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::isOk().

bool org::xmlBlaster::client::qos::GetReturnQos::isErased ( )

True if the message was erased by timer or by a client invoking erase().

Reimplemented in org::xmlBlaster::client::qos::UpdateQos.

Definition at line 78 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::isErased().

bool org::xmlBlaster::client::qos::GetReturnQos::isTimeout ( )

True if a timeout on this message occurred.

Timeouts are spanned by the publisher and thrown by xmlBlaster on timeout to indicate for example STALE messages or any other user problem domain specific event.

Reimplemented in org::xmlBlaster::client::qos::UpdateQos.

Definition at line 83 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::isTimeout().

Timestamp org::xmlBlaster::client::qos::GetReturnQos::getRcvTimestamp ( )

The approximate receive timestamp (UTC time), when message arrived in requestBroker.publish() method.

In milliseconds elapsed since midnight, January 1, 1970 UTC

Definition at line 88 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::getRcvTimestamp().

RouteVector org::xmlBlaster::client::qos::GetReturnQos::getRouteNodes ( )

Definition at line 93 of file GetReturnQos.cpp.

References data_, and org::xmlBlaster::util::qos::QosData::getRouteNodes().

string org::xmlBlaster::client::qos::GetReturnQos::getRcvTime ( )