org::xmlBlaster::client::qos::EraseQos Class Reference

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

[legend]Collaboration diagram for org::xmlBlaster::client::qos::EraseQos:

[legend]List of all members.

Public Member Functions
	EraseQos (org::xmlBlaster::util::Global &global)
	EraseQos (org::xmlBlaster::util::Global &global, org::xmlBlaster::util::qos::QueryQosData &data)
	EraseQos (EraseQos &qos)
EraseQos &	operator= (EraseQos &qos)
template<typename T_VALUE>
void	addClientProperty (std::string &name, T_VALUE &value, std::string &type="", std::string &encoding="")
	Add a client property key and value.
void	setForceDestroy (bool forceDestroy)
	Defaults to false: If a topic is still referenced by callback messages it will be not erased immediately but we wait until all pending messages are delivered.
void	setHistoryQos (org::xmlBlaster::util::qos::HistoryQos historyQos)

---

Detailed Description

Definition at line 33 of file EraseQos.h.

---

Constructor & Destructor Documentation

org::xmlBlaster::client::qos::EraseQos::EraseQos

(

org::xmlBlaster::util::Global &

global

)

Definition at line 35 of file EraseQos.cpp.

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

org::xmlBlaster::client::qos::EraseQos::EraseQos	(	org::xmlBlaster::util::Global &	global,
		org::xmlBlaster::util::qos::QueryQosData &	data
	)

Definition at line 40 of file EraseQos.cpp.

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

org::xmlBlaster::client::qos::EraseQos::EraseQos

(

EraseQos &

qos

)

Definition at line 46 of file EraseQos.cpp.

---

Member Function Documentation

EraseQos & org::xmlBlaster::client::qos::EraseQos::operator=

(

EraseQos &

qos

)

Definition at line 50 of file EraseQos.cpp.

References org::xmlBlaster::client::qos::UnSubscribeQos::data_.

template<typename T_VALUE>

void org::xmlBlaster::client::qos::EraseQos::addClientProperty	(	std::string &	name,
		T_VALUE &	value,
		std::string &	type = "",
		std::string &	encoding = ""
	)

Add a client property key and value.

Parameters:

	name	The unique key, a duplicate key will overwrite the old setting
	value	"vector<unsigned char>" and "unsigned char *" types are treated as a blob

See also:

ClientProperty::ClientProperty

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

Definition at line 50 of file EraseQos.h.

void org::xmlBlaster::client::qos::EraseQos::setForceDestroy

(

bool

forceDestroy

)

Defaults to false: If a topic is still referenced by callback messages it will be not erased immediately but we wait until all pending messages are delivered.

See also:

engine.message.lifecycle requirement

Definition at line 56 of file EraseQos.cpp.

References org::xmlBlaster::client::qos::UnSubscribeQos::data_, and org::xmlBlaster::util::qos::QueryQosData::setForceDestroy().

Referenced by PublishDemo::erase().

void org::xmlBlaster::client::qos::EraseQos::setHistoryQos

(

org::xmlBlaster::util::qos::HistoryQos

historyQos

)

Definition at line 61 of file EraseQos.cpp.

References org::xmlBlaster::client::qos::UnSubscribeQos::data_, and org::xmlBlaster::util::qos::QueryQosData::setHistoryQos().

---

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

• client/qos/EraseQos.h
• client/qos/EraseQos.cpp