org::xmlBlaster::client::key::MsgKeyBase Class Reference

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

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

[legend]List of all members.

Public Member Functions
	MsgKeyBase (org::xmlBlaster::util::Global &global)
	Minimal constructor.
	MsgKeyBase (org::xmlBlaster::util::Global &global, const org::xmlBlaster::util::key::MsgKeyData &data)
	MsgKeyBase (const MsgKeyBase &key)
MsgKeyBase &	operator= (const MsgKeyBase &key)
const org::xmlBlaster::util::key::MsgKeyData &	getData () const
org::xmlBlaster::util::Global &	getGlobal ()
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	getContentMime () const
	Find out which mime type (syntax) the content of the message has.
std::string	getContentMimeExtended () const
	Some further specifying information of the content.
std::string	getDomain () const
	Access the domain setting.
std::string	toXml (const std::string &extraOffset="") const
	Dump state of this object into a XML ASCII std::string.
Protected Attributes
std::string	ME
org::xmlBlaster::util::Global &	global_
org::xmlBlaster::util::I_Log &	log_
org::xmlBlaster::util::key::MsgKeyData	msgKeyData_
	subscribe(), get() and cluster configuration keys may contain a filter rule

---

Detailed Description

Definition at line 26 of file MsgKeyBase.h.

---

Constructor & Destructor Documentation

org::xmlBlaster::client::key::MsgKeyBase::MsgKeyBase

(

org::xmlBlaster::util::Global &

global

)

Minimal constructor.

Definition at line 16 of file MsgKeyBase.cpp.

org::xmlBlaster::client::key::MsgKeyBase::MsgKeyBase	(	org::xmlBlaster::util::Global &	global,
		const org::xmlBlaster::util::key::MsgKeyData &	data
	)

org::xmlBlaster::client::key::MsgKeyBase::MsgKeyBase

(

const MsgKeyBase &

key

)

---

Member Function Documentation

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

(

const MsgKeyBase &

key

)

const org::xmlBlaster::util::key::MsgKeyData& org::xmlBlaster::client::key::MsgKeyBase::getData

(

)

const

Referenced by org::xmlBlaster::test::TestKeys::testPublishKey().

org::xmlBlaster::util::Global& org::xmlBlaster::client::key::MsgKeyBase::getGlobal

(

)

Definition at line 53 of file MsgKeyBase.h.

std::string org::xmlBlaster::client::key::MsgKeyBase::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::test::TestSub::update(), org::xmlBlaster::test::TestLeaveServer::update(), org::xmlBlaster::test::TestCommand::update(), org::xmlBlaster::test::SpecificCallback::update(), org::xmlBlaster::client::protocol::corba::DefaultCallback::update(), and SubscribeDemo::update().

std::string org::xmlBlaster::client::key::MsgKeyBase::getContentMime

(

)

const

Find out which mime type (syntax) the content of the message has.

Returns:

The MIME type, for example "text/xml" in <key oid='' contentMime='text/xml'>
default is "text/plain" if not set

See also:

RFC1521 - MIME (Multipurpose Internet Mail Extensions)

Referenced by org::xmlBlaster::test::TestKeys::testPublishKey(), org::xmlBlaster::test::TestSub::update(), and TestEmptyContent::update().

std::string org::xmlBlaster::client::key::MsgKeyBase::getContentMimeExtended

(

)

const

Some further specifying information of the content.

For example the application version number the document in the content.
You may use this attribute for you own purposes.

Returns:

The MIME-extended info, for example
"Version 1.1" in <key oid='' contentMime='text/xml' contentMimeExtended='Version 1.1'>
or "" (empty std::string) if not known

Referenced by org::xmlBlaster::test::TestKeys::testPublishKey(), and org::xmlBlaster::test::TestSub::update().

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

(

)

const

Access the domain setting.

Returns:

A domain std::string or null

std::string org::xmlBlaster::client::key::MsgKeyBase::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 PublishDemo::publish(), org::xmlBlaster::test::TestKeys::testPublishKey(), org::xmlBlaster::test::TestFailsafe::update(), org::xmlBlaster::client::protocol::corba::DefaultCallback::update(), TestEmptyContent::update(), SubscribeDemo::update(), SpecificCallback::update(), and HelloWorld2::update().

---

Member Data Documentation

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

Definition at line 29 of file MsgKeyBase.h.

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

Definition at line 30 of file MsgKeyBase.h.

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

Definition at line 31 of file MsgKeyBase.h.

org::xmlBlaster::util::key::MsgKeyData org::xmlBlaster::client::key::MsgKeyBase::msgKeyData_ [protected]

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

Definition at line 36 of file MsgKeyBase.h.

---

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

• client/key/MsgKeyBase.h
• client/key/MsgKeyBase.cpp