org::xmlBlaster::util::qos::QueryQosData

org::xmlBlaster::util::qos::QueryQosData Class Reference

Inheritance diagram for org::xmlBlaster::util::qos::QueryQosData:

Inheritance graph
[legend]
Collaboration diagram for org::xmlBlaster::util::qos::QueryQosData:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 QueryQosData (org::xmlBlaster::util::Global &global)
 Constructs the specialized quality of service object for query informations, e.g.
void setMultiSubscribe (bool multiSubscribe)
bool getMultiSubscribe ()
 Allow to subscribe multiple times to the same query/oid.
void setWantInitialUpdate (bool initialUpdate)
 Do we want to have an initial update on subscribe if the message exists already?
bool getWantInitialUpdate ()
void setWantUpdateOneway (bool updateOneway)
 Do we want the callback messages of this subscription as oneway with updateOneway() or with the acknowledged update().
bool getWantUpdateOneway ()
void setWantNotify (bool notify)
bool getWantNotify ()
void setWantLocal (bool local)
 false Inhibit the delivery of messages to myself if i have published it.
bool getWantLocal ()
 false Inhibit the delivery of messages to myself if i have published it.
void setWantMeta (bool meta)
 
Parameters:
meta false: Don't send me the meta information of a message key

bool getWantMeta ()
 
Returns:
false: Don't send me the meta information of a message key

void setWantContent (bool content)
 If false, the update contains not the content (it is a notify of change only) TODO: Implement in server!!!
bool getWantContent ()
void setForceDestroy (bool forceDestroy)
 
Parameters:
forceDestroy 

bool getForceDestroy ()
 
Returns:
for erase behaviour

void addAccessFilter (org::xmlBlaster::util::qos::AccessFilterQos &filter)
 Adds your subplied subscribe filter.
AccessFilterVector getAccessFilters ()
void setHistoryQos (org::xmlBlaster::util::qos::HistoryQos &historyQos)
 Set the QoS which describes the history query settings.
void setQueryQos (int maxEntries, long timeout, bool consumable)
org::xmlBlaster::util::qos::HistoryQos getHistoryQos ()
 Get the QoS which describes the history query settings.
std::string getSubscriptionId ()
 Get the identifier (unique handle) for this subscription.
void setSubscriptionId (std::string &subscriptionId)
 Force the identifier (unique handle) for this subscription.
std::string toXml (std::string &extraOffset="")
 Dump state of this object into a XML ASCII std::string.
QueryQosData * getClone ()
 Allocate a clone.

Detailed Description

Definition at line 46 of file QueryQosData.h.

Constructor & Destructor Documentation

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

Constructs the specialized quality of service object for query informations, e.g.

for a subscribe() call

Parameters:
The factory which knows how to serialize and parse me

Definition at line 78 of file QueryQosData.cpp.

References org::xmlBlaster::util::qos::QosData::ME.

Referenced by getClone().

Member Function Documentation

void org::xmlBlaster::util::qos::QueryQosData::setMultiSubscribe ( bool  multiSubscribe  ) 

Definition at line 143 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::SubscribeQos::setMultiSubscribe().

bool org::xmlBlaster::util::qos::QueryQosData::getMultiSubscribe (  ) 

Allow to subscribe multiple times to the same query/oid.

Returns:
defaults to true

Definition at line 148 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::SubscribeQos::getMultiSubscribe().

void org::xmlBlaster::util::qos::QueryQosData::setWantInitialUpdate ( bool  initialUpdate  ) 

Do we want to have an initial update on subscribe if the message exists already?

Returns:
true if initial update wanted false if only updates on new publishes are sent
See also:
The engine.qos.subscribe.initialUpdate requirement

Definition at line 106 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::SubscribeQos::setWantInitialUpdate().

bool org::xmlBlaster::util::qos::QueryQosData::getWantInitialUpdate (  ) 

Definition at line 111 of file QueryQosData.cpp.

void org::xmlBlaster::util::qos::QueryQosData::setWantUpdateOneway ( bool  updateOneway  ) 

Do we want the callback messages of this subscription as oneway with updateOneway() or with the acknowledged update().

Parameters:
updateOneway Defaults to false.
See also:
The interface.subscribe requirement

QueryQosData::setWantUpdateOneway(boolean)

Definition at line 123 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::SubscribeQos::setWantUpdateOneway().

bool org::xmlBlaster::util::qos::QueryQosData::getWantUpdateOneway (  ) 

Definition at line 128 of file QueryQosData.cpp.

void org::xmlBlaster::util::qos::QueryQosData::setWantNotify ( bool  notify  ) 

Definition at line 133 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::SubscribeQos::setWantNotify().

bool org::xmlBlaster::util::qos::QueryQosData::getWantNotify (  ) 

Definition at line 138 of file QueryQosData.cpp.

void org::xmlBlaster::util::qos::QueryQosData::setWantLocal ( bool  local  ) 

false Inhibit the delivery of messages to myself if i have published it.

Definition at line 156 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::SubscribeQos::setWantLocal().

bool org::xmlBlaster::util::qos::QueryQosData::getWantLocal (  ) 

false Inhibit the delivery of messages to myself if i have published it.

Definition at line 164 of file QueryQosData.cpp.

void org::xmlBlaster::util::qos::QueryQosData::setWantMeta ( bool  meta  ) 

Parameters:
meta false: Don't send me the meta information of a message key

Definition at line 172 of file QueryQosData.cpp.

bool org::xmlBlaster::util::qos::QueryQosData::getWantMeta (  ) 

Returns:
false: Don't send me the meta information of a message key

Definition at line 180 of file QueryQosData.cpp.

void org::xmlBlaster::util::qos::QueryQosData::setWantContent ( bool  content  ) 

If false, the update contains not the content (it is a notify of change only) TODO: Implement in server!!!

Definition at line 189 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::GetQos::setWantContent().

bool org::xmlBlaster::util::qos::QueryQosData::getWantContent (  ) 

Definition at line 194 of file QueryQosData.cpp.

void org::xmlBlaster::util::qos::QueryQosData::setForceDestroy ( bool  forceDestroy  ) 

Parameters:
forceDestroy 

Definition at line 202 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::EraseQos::setForceDestroy().

bool org::xmlBlaster::util::qos::QueryQosData::getForceDestroy (  ) 

Returns:
for erase behaviour

Definition at line 210 of file QueryQosData.cpp.

void org::xmlBlaster::util::qos::QueryQosData::addAccessFilter ( org::xmlBlaster::util::qos::AccessFilterQos &  filter  ) 

Adds your subplied subscribe filter.

Definition at line 218 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::GetQos::addAccessFilter().

AccessFilterVector org::xmlBlaster::util::qos::QueryQosData::getAccessFilters (  ) 

Definition at line 223 of file QueryQosData.cpp.

void org::xmlBlaster::util::qos::QueryQosData::setHistoryQos ( org::xmlBlaster::util::qos::HistoryQos &  historyQos  ) 

Set the QoS which describes the history query settings.

Definition at line 232 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::GetQos::setHistoryQos(), and org::xmlBlaster::client::qos::EraseQos::setHistoryQos().

void org::xmlBlaster::util::qos::QueryQosData::setQueryQos ( int  maxEntries,
long  timeout,
bool  consumable 
)

Definition at line 246 of file QueryQosData.cpp.

HistoryQos org::xmlBlaster::util::qos::QueryQosData::getHistoryQos (  ) 

Get the QoS which describes the history query settings.

Returns:
never null

Definition at line 241 of file QueryQosData.cpp.

string org::xmlBlaster::util::qos::QueryQosData::getSubscriptionId (  ) 

Get the identifier (unique handle) for this subscription.

Returns:
The id or null if not specified by client.
See also:
The engine.qos.subscribe.id requirement

Definition at line 257 of file QueryQosData.cpp.

Referenced by org::xmlBlaster::client::qos::SubscribeQos::generateSubscriptionId(), and org::xmlBlaster::client::qos::SubscribeQos::hasSubscriptionId().

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

Force the identifier (unique handle) for this subscription.

Usually you let the identifier be generated by xmlBlaster.

See also:
The engine.qos.subscribe.id requirement

std::string org::xmlBlaster::util::qos::QueryQosData::toXml ( std::string &  extraOffset = ""  )  [virtual]

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


Parameters:
extraOffset indenting of tags for nice output
Returns:
internal state of the query as a XML ASCII std::string

Reimplemented from org::xmlBlaster::util::qos::QosData.

Referenced by org::xmlBlaster::client::qos::UnSubscribeQos::toXml().

QueryQosData * org::xmlBlaster::util::qos::QueryQosData::getClone (  )  [virtual]

Allocate a clone.

Returns:
The caller needs to free it with 'delete'.

Reimplemented from org::xmlBlaster::util::qos::QosData.

Definition at line 328 of file QueryQosData.cpp.

References QueryQosData().

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