org::xmlBlaster::client::qos::UpdateQos Class Reference

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

Inheritance graph
[legend]
Collaboration diagram for org::xmlBlaster::client::qos::UpdateQos:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 UpdateQos (org::xmlBlaster::util::Global &global, org::xmlBlaster::util::qos::MsgQosData data)
 UpdateQos (UpdateQos &data)
UpdateQosoperator= (UpdateQos &data)
bool isSubscribable ()
 Test if Publish/Subscribe style is used.
bool isPtp ()
 Test if Point to Point addressing style is used.
std::string getSubscriptionId ()
 If Pub/Sub style update: contains the subscribe ID which caused this update.
int getRedeliver ()
 Returns > 0 if the message probably is redelivered.
long getQueueSize ()
 
Returns:
The number of queued messages

long getQueueIndex ()
 
Returns:
The index of the message in the queue

bool isOk ()
 True if the message is OK.
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.
bool isForwardError ()
 True on cluster forward problems.

Detailed Description

Definition at line 57 of file UpdateQos.h.


Constructor & Destructor Documentation

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

Definition at line 17 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::ME.

org::xmlBlaster::client::qos::UpdateQos::UpdateQos ( UpdateQos data  ) 

Definition at line 23 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::ME.


Member Function Documentation

UpdateQos & org::xmlBlaster::client::qos::UpdateQos::operator= ( UpdateQos data  ) 

Definition at line 29 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::ME, and org::xmlBlaster::client::qos::GetReturnQos::operator=().

bool org::xmlBlaster::client::qos::UpdateQos::isSubscribable (  ) 

Test if Publish/Subscribe style is used.

Returns:
true if Publish/Subscribe style is used

Definition at line 42 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::data_, and org::xmlBlaster::util::qos::MsgQosData::isSubscribable().

bool org::xmlBlaster::client::qos::UpdateQos::isPtp (  ) 

Test if Point to Point addressing style is used.

Returns:
true if addressing of the destination is used false if no destination is given

Definition at line 53 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::data_, and org::xmlBlaster::util::qos::MsgQosData::isPtp().

string org::xmlBlaster::client::qos::UpdateQos::getSubscriptionId (  ) 

If Pub/Sub style update: contains the subscribe ID which caused this update.

Returns:
subscribeId or null if PtP message

Definition at line 62 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::data_, and org::xmlBlaster::util::qos::MsgQosData::getSubscriptionId().

Referenced by org::xmlBlaster::test::TestSub::update().

int org::xmlBlaster::client::qos::UpdateQos::getRedeliver (  ) 

Returns > 0 if the message probably is redelivered.

Returns:
== 0 The message is guaranteed to be delivered only once.

Definition at line 71 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::data_, and org::xmlBlaster::util::qos::MsgQosData::getRedeliver().

long org::xmlBlaster::client::qos::UpdateQos::getQueueSize (  ) 

Returns:
The number of queued messages

Definition at line 79 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::data_, and org::xmlBlaster::util::qos::MsgQosData::getQueueSize().

long org::xmlBlaster::client::qos::UpdateQos::getQueueIndex (  ) 

Returns:
The index of the message in the queue

Definition at line 87 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::data_, and org::xmlBlaster::util::qos::MsgQosData::getQueueIndex().

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

True if the message is OK.

Reimplemented from org::xmlBlaster::client::qos::GetReturnQos.

Definition at line 92 of file UpdateQos.cpp.

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

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

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

Reimplemented from org::xmlBlaster::client::qos::GetReturnQos.

Definition at line 97 of file UpdateQos.cpp.

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

Referenced by SubscribeDemo::update().

bool org::xmlBlaster::client::qos::UpdateQos::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 from org::xmlBlaster::client::qos::GetReturnQos.

Definition at line 102 of file UpdateQos.cpp.

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

bool org::xmlBlaster::client::qos::UpdateQos::isForwardError (  ) 

True on cluster forward problems.

Definition at line 107 of file UpdateQos.cpp.

References org::xmlBlaster::client::qos::GetReturnQos::data_, and org::xmlBlaster::util::qos::QosData::isForwardError().


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