org::xmlBlaster::client::qos::PublishReturnQos Class Reference

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 PublishReturnQos (org::xmlBlaster::util::Global &global, const org::xmlBlaster::util::qos::StatusQosData &data)
 Constructs the specialized quality of service object for status informations, e.g.
 PublishReturnQos (org::xmlBlaster::util::Global &global)
 PublishReturnQos (const PublishReturnQos &data)
PublishReturnQos operator= (const PublishReturnQos &data)
std::string getState () const
 Access state of message on update().
void setState (const std::string &state)
 Sets the state (used when queuing messages and giving back the status to the client.
std::string getStateInfo () const
 Access state of message on update().
std::string getKeyOid () const
 Access key oid.
void setKeyOid (const std::string &oid)
 Sets the soid (used when queuing messages and giving back the status to the client.
org::xmlBlaster::util::Timestamp getRcvTimestamp () const
 The approximate receive timestamp (UTC time), when message arrived in requestBroker.publish() method.
std::string toXml (const std::string &extraOffset="") const
 Dump state of this object into a XML ASCII std::string.
org::xmlBlaster::util::qos::StatusQosDatagetData ()

Detailed Description

Definition at line 31 of file PublishReturnQos.h.


Constructor & Destructor Documentation

org::xmlBlaster::client::qos::PublishReturnQos::PublishReturnQos ( 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:
The factory which knows how to serialize and parse me

org::xmlBlaster::client::qos::PublishReturnQos::PublishReturnQos ( org::xmlBlaster::util::Global global  ) 

Definition at line 21 of file PublishReturnQos.cpp.

org::xmlBlaster::client::qos::PublishReturnQos::PublishReturnQos ( const PublishReturnQos data  ) 


Member Function Documentation

PublishReturnQos org::xmlBlaster::client::qos::PublishReturnQos::operator= ( const PublishReturnQos data  ) 

std::string org::xmlBlaster::client::qos::PublishReturnQos::getState (  )  const

Access state of message on update().

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

Referenced by PublishDemo::postSend().

void org::xmlBlaster::client::qos::PublishReturnQos::setState ( const std::string &  state  ) 

Sets the state (used when queuing messages and giving back the status to the client.

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::queuePublish().

std::string org::xmlBlaster::client::qos::PublishReturnQos::getStateInfo (  )  const

Access state of message on update().

Returns:
The human readable info text

std::string org::xmlBlaster::client::qos::PublishReturnQos::getKeyOid (  )  const

Access key oid.

Returns:
The unique identifier of a message

Referenced by MultiConnectDemo::execute(), org::xmlBlaster::test::TestSubXPath::testInitial(), org::xmlBlaster::test::TestSub::testPublishCorbaMethods(), and org::xmlBlaster::test::TestSub::testPublishSTLMethods().

void org::xmlBlaster::client::qos::PublishReturnQos::setKeyOid ( const std::string &  oid  ) 

Sets the soid (used when queuing messages and giving back the status to the client.

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::queuePublish().

org::xmlBlaster::util::Timestamp org::xmlBlaster::client::qos::PublishReturnQos::getRcvTimestamp (  )  const

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


In milliseconds elapsed since midnight, January 1, 1970 UTC

std::string org::xmlBlaster::client::qos::PublishReturnQos::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(), and PublishDemo::publish().

StatusQosData & org::xmlBlaster::client::qos::PublishReturnQos::getData (  ) 

Definition at line 61 of file PublishReturnQos.cpp.

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::queuePublish().


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