org::xmlBlaster::client::key::UnSubscribeKey Class Reference

Inheritance diagram for org::xmlBlaster::client::key::UnSubscribeKey:

[legend]Collaboration diagram for org::xmlBlaster::client::key::UnSubscribeKey:

[legend]List of all members.

Public Member Functions
	UnSubscribeKey (org::xmlBlaster::util::Global &global)
	Minimal constructor.
	UnSubscribeKey (org::xmlBlaster::util::Global &global, const std::string &query, const std::string &queryType=org::xmlBlaster::util::Constants::EXACT)
	UnSubscribeKey (org::xmlBlaster::util::Global &global, const org::xmlBlaster::util::key::QueryKeyData &data)
	UnSubscribeKey (const UnSubscribeKey &key)
UnSubscribeKey &	operator= (const UnSubscribeKey &key)
void	setOid (const std::string &oid)
std::string	getOid () const
	Returns: The key oid or "" if not set (see org::xmlBlaster::util::key::MsgKeyData.getOid() which generates the oid if it was "").
std::string	getQueryType () const
	Access the query type "XPATH" or "EXACT".
void	setQueryString (const std::string &tags)
	Your XPath query std::string.
std::string	getQueryString () const
void	setDomain (const std::string &domain)
	Set the domain for this message, can be used for a simple grouping of messages to their master node with xmlBlaster clusters.
std::string	getDomain () const
	Access the domain setting.
std::string	getUrl () const
	Access simplified URL like string.
std::string	toXml (const std::string &extraOffset="") const
	Dump state of this object into a XML ASCII std::string.
std::string	wrap (const std::string &str)
	May be used to integrate your application tags.
const org::xmlBlaster::util::key::QueryKeyData &	getData () const
Protected Attributes
std::string	ME
org::xmlBlaster::util::Global &	global_
org::xmlBlaster::util::I_Log &	log_
org::xmlBlaster::util::key::QueryKeyData	queryKeyData_
	subscribe(), get() and cluster configuration keys may contain a filter rule

---

Detailed Description

Definition at line 24 of file UnSubscribeKey.h.

---

Constructor & Destructor Documentation

org::xmlBlaster::client::key::UnSubscribeKey::UnSubscribeKey

(

org::xmlBlaster::util::Global &

global

)

Minimal constructor.

Definition at line 16 of file UnSubscribeKey.cpp.

org::xmlBlaster::client::key::UnSubscribeKey::UnSubscribeKey	(	org::xmlBlaster::util::Global &	global,
		const std::string &	query,
		const std::string &	queryType = org::xmlBlaster::util::Constants::EXACT
	)

org::xmlBlaster::client::key::UnSubscribeKey::UnSubscribeKey	(	org::xmlBlaster::util::Global &	global,
		const org::xmlBlaster::util::key::QueryKeyData &	data
	)

org::xmlBlaster::client::key::UnSubscribeKey::UnSubscribeKey

(

const UnSubscribeKey &

key

)

---

Member Function Documentation

UnSubscribeKey& org::xmlBlaster::client::key::UnSubscribeKey::operator=

(

const UnSubscribeKey &

key

)

void org::xmlBlaster::client::key::UnSubscribeKey::setOid

(

const std::string &

oid

)

Referenced by PublishDemo::erase(), TestEmptyContent::execute(), MultiConnectDemo::execute(), HelloWorld2::execute(), org::xmlBlaster::test::TestFailsafe::setUp(), SubscribeDemo::subscribe(), org::xmlBlaster::test::TestSub::tearDown(), org::xmlBlaster::test::TestGet::tearDown(), org::xmlBlaster::test::TestFailsafe::tearDown(), org::xmlBlaster::test::TestGet::testGet(), org::xmlBlaster::test::TestSubXPath::testInitial(), org::xmlBlaster::test::TestLeaveServer::testLeaveServer(), org::xmlBlaster::test::TestGet::testMany(), org::xmlBlaster::test::TestRam::testPublish(), org::xmlBlaster::test::TestConnect::testPubSub(), and org::xmlBlaster::test::TestFailsafe::testReconnect().

std::string org::xmlBlaster::client::key::UnSubscribeKey::getOid

(

)

const

Returns:

The key oid or "" if not set (see org::xmlBlaster::util::key::MsgKeyData.getOid() which generates the oid if it was "").

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::queueSubscribe(), and org::xmlBlaster::util::dispatch::ConnectionsHandler::subscribe().

std::string org::xmlBlaster::client::key::UnSubscribeKey::getQueryType

(

)

const

Access the query type "XPATH" or "EXACT".

Returns:

A queryType std::string or ""

void org::xmlBlaster::client::key::UnSubscribeKey::setQueryString

(

const std::string &

tags

)

Your XPath query std::string.

Parameters:

str

Your tags in ASCII XML syntax

Referenced by SubscribeDemo::subscribe(), and org::xmlBlaster::test::TestSub::testSubscribeXPath().

std::string org::xmlBlaster::client::key::UnSubscribeKey::getQueryString

(

)

const

void org::xmlBlaster::client::key::UnSubscribeKey::setDomain

(

const std::string &

domain

)

Set the domain for this message, can be used for a simple grouping of messages to their master node with xmlBlaster clusters.

Parameters:

The

domain, any chosen std::string in your problem domain, e.g. "RUGBY" or "RADAR_TRACK" defaults to "" where the local xmlBlaster instance is the master of the message.

See also:

The cluster requirement

Reimplemented in org::xmlBlaster::client::key::SubscribeKey.

Referenced by SubscribeDemo::unSubscribe_().

std::string org::xmlBlaster::client::key::UnSubscribeKey::getDomain

(

)

const

Access the domain setting.

Returns:

A domain std::string or null

Reimplemented in org::xmlBlaster::client::key::SubscribeKey.

std::string org::xmlBlaster::client::key::UnSubscribeKey::getUrl

(

)

const

Access simplified URL like string.

Returns:

examples are "exact:hello", "xpath://key", "domain:sport"

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

std::string org::xmlBlaster::client::key::UnSubscribeKey::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 query as a XML ASCII std::string

Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::erase(), org::xmlBlaster::client::XmlBlasterAccess::erase(), org::xmlBlaster::client::protocol::corba::CorbaDriver::erase(), TestEmptyContent::execute(), HelloWorld2::execute(), org::xmlBlaster::util::dispatch::ConnectionsHandler::get(), org::xmlBlaster::client::XmlBlasterAccess::get(), org::xmlBlaster::client::protocol::socket::SocketDriver::get(), org::xmlBlaster::client::protocol::corba::CorbaDriver::get(), org::xmlBlaster::test::TestFailsafe::setUp(), org::xmlBlaster::util::dispatch::ConnectionsHandler::subscribe(), org::xmlBlaster::client::XmlBlasterAccess::subscribe(), org::xmlBlaster::client::protocol::socket::SocketDriver::subscribe(), org::xmlBlaster::client::protocol::corba::CorbaDriver::subscribe(), SubscribeDemo::subscribe(), org::xmlBlaster::test::TestFailsafe::tearDown(), org::xmlBlaster::util::dispatch::ConnectionsHandler::unSubscribe(), org::xmlBlaster::client::XmlBlasterAccess::unSubscribe(), org::xmlBlaster::client::protocol::socket::SocketDriver::unSubscribe(), org::xmlBlaster::client::protocol::corba::CorbaDriver::unSubscribe(), and SubscribeDemo::unSubscribe_().

std::string org::xmlBlaster::client::key::UnSubscribeKey::wrap

(

const std::string &

str

)

May be used to integrate your application tags.

Parameters:

str

Your tags

Returns:

The ASCII XML key containing the key tag and your tags

const org::xmlBlaster::util::key::QueryKeyData& org::xmlBlaster::client::key::UnSubscribeKey::getData

(

)

const

---

Member Data Documentation

std::string org::xmlBlaster::client::key::UnSubscribeKey::ME [protected]

Definition at line 27 of file UnSubscribeKey.h.

org::xmlBlaster::util::Global& org::xmlBlaster::client::key::UnSubscribeKey::global_ [protected]

Definition at line 28 of file UnSubscribeKey.h.

org::xmlBlaster::util::I_Log& org::xmlBlaster::client::key::UnSubscribeKey::log_ [protected]

Definition at line 29 of file UnSubscribeKey.h.

org::xmlBlaster::util::key::QueryKeyData org::xmlBlaster::client::key::UnSubscribeKey::queryKeyData_ [protected]

subscribe(), get() and cluster configuration keys may contain a filter rule

Definition at line 34 of file UnSubscribeKey.h.

---

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

• client/key/UnSubscribeKey.h
• client/key/UnSubscribeKey.cpp