org::xmlBlaster::util::qos::HistoryQos Class Reference

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 HistoryQos (org::xmlBlaster::util::Global &global, long numOfEntries=-1)
 
Parameters:
glob The global handle holding environment and logging objects

 HistoryQos (const HistoryQos &qos)
HistoryQosoperator= (const HistoryQos &qos)
void setNumEntries (long numOfEntries)
 
Parameters:
numEntries The number of history entries

long getNumEntries () const
 Returns the number of history entries.
void setNewestFirst (bool newestFirst)
 The sorting order in which the history entries are delivered.
bool getNewestFirst () const
 
Returns:
defaults to true

std::string toXml (const std::string &extraOffset="") const
 Dump state of this object into a XML ASCII std::string.

Detailed Description

Definition at line 41 of file HistoryQos.h.


Constructor & Destructor Documentation

org::xmlBlaster::util::qos::HistoryQos::HistoryQos ( org::xmlBlaster::util::Global global,
long  numOfEntries = -1 
)

Parameters:
glob The global handle holding environment and logging objects

Definition at line 20 of file HistoryQos.cpp.

References org::xmlBlaster::util::qos::DEFAULT_numEntries, org::xmlBlaster::util::Property::getLongProperty(), org::xmlBlaster::util::Global::getProperty(), and setNumEntries().

org::xmlBlaster::util::qos::HistoryQos::HistoryQos ( const HistoryQos qos  ) 


Member Function Documentation

HistoryQos& org::xmlBlaster::util::qos::HistoryQos::operator= ( const HistoryQos qos  ) 

void org::xmlBlaster::util::qos::HistoryQos::setNumEntries ( long  numOfEntries  ) 

Parameters:
numEntries The number of history entries

Definition at line 44 of file HistoryQos.cpp.

Referenced by HistoryQos(), and SubscribeDemo::subscribe().

long org::xmlBlaster::util::qos::HistoryQos::getNumEntries (  )  const

Returns the number of history entries.

Returns:
e.g. 1

void org::xmlBlaster::util::qos::HistoryQos::setNewestFirst ( bool  newestFirst  ) 

The sorting order in which the history entries are delivered.

The higher priority messages are always delivered first. In one priority the newest message is delivered first with 'true', setting 'false' reverts the delivery sequence in this priority.

Parameters:
newestFirst defaults to true.

Definition at line 55 of file HistoryQos.cpp.

Referenced by SubscribeDemo::subscribe().

bool org::xmlBlaster::util::qos::HistoryQos::getNewestFirst (  )  const

Returns:
defaults to true

See also:
setNewestFirst(boolean)

std::string org::xmlBlaster::util::qos::HistoryQos::toXml ( const std::string &  extraOffset = ""  )  const

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


Only none default values are dumped for performance reasons

Parameters:
extraOffset indenting of tags for nice output
Returns:
The xml representation or "" if all settings are default


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