org::xmlBlaster::util::qos::StatusQosData

org::xmlBlaster::util::qos::StatusQosData Class Reference

Collaboration diagram for org::xmlBlaster::util::qos::StatusQosData:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 StatusQosData (org::xmlBlaster::util::Global &global)
 Constructs the specialized quality of service object for status informations, e.g.
 StatusQosData (const StatusQosData &data)
StatusQosData operator= (const StatusQosData &data)
void setState (const std::string &state)
 
Parameters:
state The state of an update message.

std::string getState () const
 Access state of message on update().
bool isOk () const
 True if the message is OK on update().
bool isErased () const
 True if the message was erased by timer or by a client invoking erase().
bool isTimeout () const
 True if a timeout on this message occurred.
bool isForwardError () const
 True on cluster forward problems.
void setStateInfo (const std::string &stateInfo)
 
Parameters:
state The human readable state text of an update message

std::string getStateInfo () const
 Access state of message on update().
void setSubscriptionId (const std::string &subscriptionId)
 If Pub/Sub style update: contains the subscribe ID which caused this update.
std::string getSubscriptionId () const
 If Pub/Sub style update: contains the subscribe ID which caused this update.
std::string getKeyOid () const
 Access key oid.
void setKeyOid (const std::string &oid)
 Access unique oid of a message topic.
int size () const
 The size in bytes of the data in XML form.
std::string toXml (const std::string &extraOffset="") const
 Dump state of this object into a XML ASCII std::string.
void setRcvTimestamp (Timestamp rcvTimestamp)
 The approximate receive timestamp (UTC time), when message arrived in requestBroker.publish() method.
Timestamp getRcvTimestamp () const
 The approximate receive timestamp (UTC time), when message arrived in requestBroker.publish() method.
void touchRcvTimestamp ()
 Set timestamp to current time.
void setPersistent (bool persistent)
 
Parameters:
persistent mark a message as persistent

bool isPersistent () const
 
Returns:
true/false

Detailed Description

Definition at line 36 of file StatusQosData.h.

Constructor & Destructor Documentation

org::xmlBlaster::util::qos::StatusQosData::StatusQosData ( org::xmlBlaster::util::Global &  global  ) 

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:
The factory which knows how to serialize and parse me

Definition at line 46 of file StatusQosData.cpp.

References org::xmlBlaster::util::Constants::STATE_OK.

org::xmlBlaster::util::qos::StatusQosData::StatusQosData ( const StatusQosData &  data  ) 

Member Function Documentation

StatusQosData org::xmlBlaster::util::qos::StatusQosData::operator= ( const StatusQosData &  data  ) 

void org::xmlBlaster::util::qos::StatusQosData::setState ( const std::string &  state  ) 

Parameters:
state The state of an update message.

See Constants::java

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::queueSubscribe(), and org::xmlBlaster::test::TestQos::testStatusQos().

std::string org::xmlBlaster::util::qos::StatusQosData::getState (  )  const

Access state of message on update().

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

Referenced by org::xmlBlaster::test::TestQos::testStatusQos().

bool org::xmlBlaster::util::qos::StatusQosData::isOk (  )  const

True if the message is OK on update().

bool org::xmlBlaster::util::qos::StatusQosData::isErased (  )  const

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

bool org::xmlBlaster::util::qos::StatusQosData::isTimeout (  )  const

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.

bool org::xmlBlaster::util::qos::StatusQosData::isForwardError (  )  const

True on cluster forward problems.

void org::xmlBlaster::util::qos::StatusQosData::setStateInfo ( const std::string &  stateInfo  ) 

Parameters:
state The human readable state text of an update message

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::queuePublish(), org::xmlBlaster::util::dispatch::ConnectionsHandler::queueSubscribe(), and org::xmlBlaster::test::TestQos::testStatusQos().

std::string org::xmlBlaster::util::qos::StatusQosData::getStateInfo (  )  const

Access state of message on update().

Returns:
The human readable info text

Referenced by org::xmlBlaster::test::TestQos::testStatusQos().

void org::xmlBlaster::util::qos::StatusQosData::setSubscriptionId ( const std::string &  subscriptionId  ) 

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

Parameters:
subscriptionId null if PtP message

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::queueSubscribe(), and org::xmlBlaster::test::TestQos::testStatusQos().

std::string org::xmlBlaster::util::qos::StatusQosData::getSubscriptionId (  )  const

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

Returns:
subscribeId or null if PtP message

Referenced by org::xmlBlaster::test::TestQos::testStatusQos().

std::string org::xmlBlaster::util::qos::StatusQosData::getKeyOid (  )  const

Access key oid.

Returns:
The unique identifier of a message

Referenced by org::xmlBlaster::test::TestQos::testStatusQos().

void org::xmlBlaster::util::qos::StatusQosData::setKeyOid ( const std::string &  oid  ) 

Access unique oid of a message topic.

Referenced by org::xmlBlaster::test::TestQos::testStatusQos().

int org::xmlBlaster::util::qos::StatusQosData::size (  )  const

The size in bytes of the data in XML form.

std::string org::xmlBlaster::util::qos::StatusQosData::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 org::xmlBlaster::test::TestQos::testStatusQos().

void org::xmlBlaster::util::qos::StatusQosData::setRcvTimestamp ( Timestamp  rcvTimestamp  ) 

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 157 of file StatusQosData.cpp.

Timestamp org::xmlBlaster::util::qos::StatusQosData::getRcvTimestamp (  )  const

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


In milliseconds elapsed since midnight, January 1, 1970 UTC

void org::xmlBlaster::util::qos::StatusQosData::touchRcvTimestamp (  ) 

Set timestamp to current time.

Definition at line 167 of file StatusQosData.cpp.

References org::xmlBlaster::util::TimestampFactory::getInstance, and org::xmlBlaster::util::TimestampFactory::getTimestamp().

void org::xmlBlaster::util::qos::StatusQosData::setPersistent ( bool  persistent  ) 

Parameters:
persistent mark a message as persistent

Definition at line 175 of file StatusQosData.cpp.

Referenced by org::xmlBlaster::test::TestQos::testStatusQos().

bool org::xmlBlaster::util::qos::StatusQosData::isPersistent (  )  const

Returns:
true/false

Referenced by org::xmlBlaster::test::TestQos::testStatusQos().

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