org::xmlBlaster::util::qos::ConnectQosData

org::xmlBlaster::util::qos::ConnectQosData Class Reference

Holds the connect() QoS XML markup. More...

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

[legend]Collaboration diagram for org::xmlBlaster::util::qos::ConnectQosData:

[legend]List of all members.

Public Types

typedef std::map< std::string,
org::xmlBlaster::util::qos::ClientProperty > ClientPropertyMap

Public Member Functions

ConnectQosData (org::xmlBlaster::util::Global &global, std::string &user="", std::string &passwd="", long publicSessionId=0)

ConnectQosData (ConnectQosData &data)

ConnectQosData & operator= (ConnectQosData &data)

bool getPtp ()

std::string & getBoolAsString (bool boolVal)

void setPtp (bool ptp)

void setSessionQos (org::xmlBlaster::util::qos::SessionQos &sessionQos)

org::xmlBlaster::util::qos::SessionQos & getSessionQos ()

void setSessionQos (org::xmlBlaster::util::qos::SessionQosRef sessionQos)

org::xmlBlaster::util::qos::SessionQosRef getSessionQosRef ()

std::string getSecretSessionId ()

std::string getUserId ()

std::string getCallbackType ()

void setSecurityQos (org::xmlBlaster::authentication::SecurityQos &securityQos)

org::xmlBlaster::authentication::SecurityQos & getSecurityQos ()

void setClusterNode (bool clusterNode)

bool isClusterNode ()

void setRefreshSession (bool refreshSession)

Extend the session lifetime.

bool isRefreshSession ()

void setDuplicateUpdates (bool duplicateUpdates)

bool isDuplicateUpdates ()

std::vector< ServerRef > getServerReferences ()

Returned in ConnectReturnQos from xmlBlaster showing all access addresses.

bool isReconnected ()

Used for ConnetReturnQos only.

void setReconnected (bool reconnected)

std::string getInstanceId ()

Unique id of the xmlBlaster server (or a client), changes on each restart.

void setInstanceId (std::string instanceId)

bool isPersistent ()

Returns:: true/false

void setPersistent (bool persistent)

Parameters:

persistent

mark a message as persistent

org::xmlBlaster::util::ServerRef getServerRef ()

returns the first found server reference delivered with return QoS of a connect() call.

std::string toXml (std::string &extraOffset="")

void setAddress (org::xmlBlaster::util::qos::address::AddressBaseRef &address)

Parameters:

address

You need to create the address with 'new Address()', we take care to delete it.

org::xmlBlaster::util::qos::address::AddressBaseRef getAddress ()

void addCbAddress (org::xmlBlaster::util::qos::address::AddressBaseRef &cbAddress)

Parameters:

cbAddress

We take a copy of this so you can destroy your address after setting.

org::xmlBlaster::util::qos::address::AddressBaseRef getCbAddress ()

void addClientQueueProperty (org::xmlBlaster::util::qos::storage::ClientQueueProperty &prop)

Parameters:

prop

We take a copy of this so you can destroy your property after setting.

org::xmlBlaster::util::qos::storage::ClientQueueProperty & getClientQueueProperty ()

Access the configuration settings of the client side queue and server address.

void setSessionCbQueueProperty (org::xmlBlaster::util::qos::storage::CbQueueProperty &prop)

Parameters:

prop

We take a copy of this so you can destroy your property after setting.

org::xmlBlaster::util::qos::storage::CbQueueProperty & getSessionCbQueueProperty ()

Access the configuration settings of the server side callback queue and callback address.

std::string dumpClientProperties (std::string &extraOffset, bool clearText=false)

void addClientProperty (ClientProperty &clientProperty)

Add a client property.

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.

template<typename T_VALUE>

T_VALUE getClientProperty (std::string &name, T_VALUE &defaultValue)

Access the value for the given name, if not found returns the defaultValue.

ClientPropertyMap & getClientProperties ()

Protected Attributes

ClientPropertyMap

clientProperties_

Friends

class ConnectQosFactory

Detailed Description

Holds the connect() QoS XML markup.

See also:: The interface.connect requirement

Definition at line 36 of file ConnectQos.h.

Member Typedef Documentation

typedef std::map<std::string, org::xmlBlaster::util::qos::ClientProperty> org::xmlBlaster::util::qos::ConnectQosData::ClientPropertyMap

Definition at line 39 of file ConnectQos.h.

Constructor & Destructor Documentation

org::xmlBlaster::util::qos::ConnectQosData::ConnectQosData	(	org::xmlBlaster::util::Global &	global,
		std::string &	user = `""`,
		std::string &	passwd = `""`,
		long	publicSessionId = `0`
	)

org::xmlBlaster::util::qos::ConnectQosData::ConnectQosData ( ConnectQosData & data )

Definition at line 50 of file ConnectQos.cpp.

Member Function Documentation

ConnectQosData & org::xmlBlaster::util::qos::ConnectQosData::operator= ( ConnectQosData & data )

Definition at line 65 of file ConnectQos.cpp.

bool org::xmlBlaster::util::qos::ConnectQosData::getPtp ( )

Definition at line 71 of file ConnectQos.cpp.

string & org::xmlBlaster::util::qos::ConnectQosData::getBoolAsString ( bool boolVal )

Definition at line 76 of file ConnectQos.cpp.

References org::xmlBlaster::util::Global::getBoolAsString().

void org::xmlBlaster::util::qos::ConnectQosData::setPtp ( bool ptp )

Definition at line 81 of file ConnectQos.cpp.

void org::xmlBlaster::util::qos::ConnectQosData::setSessionQos ( org::xmlBlaster::util::qos::SessionQos & sessionQos )

Definition at line 86 of file ConnectQos.cpp.

Referenced by org::xmlBlaster::util::EmbeddedServer::isSomeServerResponding(), and org::xmlBlaster::test::TestFailsafe::testReconnect().

SessionQos & org::xmlBlaster::util::qos::ConnectQosData::getSessionQos ( )

Definition at line 93 of file ConnectQos.cpp.

Referenced by Leak::checkConnection(), Leak::checkConnection2(), Leak::checkConnection3(), org::xmlBlaster::client::XmlBlasterAccess::connect(), MultiConnectDemo::execute(), org::xmlBlaster::test::TestSub::setUp(), org::xmlBlaster::test::TestLeaveServer::setUp(), org::xmlBlaster::test::TestCommand::setUp(), org::xmlBlaster::test::TestFailsafe::testReconnect(), and org::xmlBlaster::test::TestSub::update().

void org::xmlBlaster::util::qos::ConnectQosData::setSessionQos ( org::xmlBlaster::util::qos::SessionQosRef sessionQos )

Definition at line 99 of file ConnectQos.cpp.

SessionQosRef org::xmlBlaster::util::qos::ConnectQosData::getSessionQosRef ( )

Definition at line 103 of file ConnectQos.cpp.

Referenced by org::xmlBlaster::test::TestSub::setUp(), org::xmlBlaster::test::TestLeaveServer::setUp(), and org::xmlBlaster::test::TestCommand::setUp().

string org::xmlBlaster::util::qos::ConnectQosData::getSecretSessionId ( )

Definition at line 109 of file ConnectQos.cpp.

string org::xmlBlaster::util::qos::ConnectQosData::getUserId ( )

Definition at line 114 of file ConnectQos.cpp.

string org::xmlBlaster::util::qos::ConnectQosData::getCallbackType ( )

Definition at line 119 of file ConnectQos.cpp.

References org::xmlBlaster::util::qos::storage::QueuePropertyBase::getType().

void org::xmlBlaster::util::qos::ConnectQosData::setSecurityQos ( org::xmlBlaster::authentication::SecurityQos & securityQos )

Definition at line 124 of file ConnectQos.cpp.

Referenced by org::xmlBlaster::test::TestRam::setUp(), and org::xmlBlaster::test::TestGet::setUp().

SecurityQos & org::xmlBlaster::util::qos::ConnectQosData::getSecurityQos ( )

Definition at line 129 of file ConnectQos.cpp.

void org::xmlBlaster::util::qos::ConnectQosData::setClusterNode ( bool clusterNode )

Definition at line 134 of file ConnectQos.cpp.

bool org::xmlBlaster::util::qos::ConnectQosData::isClusterNode ( )

Definition at line 139 of file ConnectQos.cpp.

void org::xmlBlaster::util::qos::ConnectQosData::setRefreshSession ( bool refreshSession )

Extend the session lifetime.

Parameters:

refreshSession

true: The client notifies xmlBlaster that it is alive and the login session is extended

Definition at line 144 of file ConnectQos.cpp.

bool org::xmlBlaster::util::qos::ConnectQosData::isRefreshSession ( )

Definition at line 149 of file ConnectQos.cpp.

void org::xmlBlaster::util::qos::ConnectQosData::setDuplicateUpdates ( bool duplicateUpdates )

Definition at line 154 of file ConnectQos.cpp.

bool org::xmlBlaster::util::qos::ConnectQosData::isDuplicateUpdates ( )

Definition at line 159 of file ConnectQos.cpp.

vector< ServerRef > org::xmlBlaster::util::qos::ConnectQosData::getServerReferences ( )

Returned in ConnectReturnQos from xmlBlaster showing all access addresses.

Definition at line 169 of file ConnectQos.cpp.

bool org::xmlBlaster::util::qos::ConnectQosData::isReconnected ( )

Used for ConnetReturnQos only.

Returns:: true A client has reconnected to an existing session

Definition at line 252 of file ConnectQos.cpp.

void org::xmlBlaster::util::qos::ConnectQosData::setReconnected ( bool reconnected )

Definition at line 257 of file ConnectQos.cpp.

std::string org::xmlBlaster::util::qos::ConnectQosData::getInstanceId ( )

Unique id of the xmlBlaster server (or a client), changes on each restart.

If 'node/heron' is restarted, the instanceId changes.

Returns:: nodeId + timestamp, '/node/heron/instanceId/33470080380'

Definition at line 262 of file ConnectQos.cpp.

void org::xmlBlaster::util::qos::ConnectQosData::setInstanceId ( std::string instanceId )

Definition at line 267 of file ConnectQos.cpp.

bool org::xmlBlaster::util::qos::ConnectQosData::isPersistent ( )

Returns:: true/false

Definition at line 283 of file ConnectQos.cpp.

void org::xmlBlaster::util::qos::ConnectQosData::setPersistent ( bool persistent )

Parameters:

persistent

mark a message as persistent

Definition at line 275 of file ConnectQos.cpp.

ServerRef org::xmlBlaster::util::qos::ConnectQosData::getServerRef ( )

returns the first found server reference delivered with return QoS of a connect() call.

Definition at line 174 of file ConnectQos.cpp.

References org::xmlBlaster::util::Global::getDefaultProtocol().

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

Referenced by org::xmlBlaster::client::XmlBlasterAccess::connect(), org::xmlBlaster::client::protocol::corba::CorbaConnection::connect(), SubscribeDemo::connect(), PublishDemo::connect(), TestEmptyContent::execute(), HelloWorld2::execute(), org::xmlBlaster::test::TestSubXPath::setUp(), and org::xmlBlaster::test::TestFailsafe::setUp().

void org::xmlBlaster::util::qos::ConnectQosData::setAddress ( org::xmlBlaster::util::qos::address::AddressBaseRef & address )

Parameters:

address

You need to create the address with 'new Address()', we take care to delete it.

Don't pass any Address instance from the stack.

Definition at line 184 of file ConnectQos.cpp.

References getClientQueueProperty(), and org::xmlBlaster::util::qos::storage::ClientQueueProperty::setAddress().

Referenced by org::xmlBlaster::test::TestFailsafe::setUp(), org::xmlBlaster::util::EmbeddedServer::start(), org::xmlBlaster::util::EmbeddedServer::stop(), and org::xmlBlaster::test::TestFailsafe::testReconnect().

AddressBaseRef org::xmlBlaster::util::qos::ConnectQosData::getAddress ( )

Definition at line 190 of file ConnectQos.cpp.

References getClientQueueProperty(), and org::xmlBlaster::util::qos::storage::ClientQueueProperty::getCurrentAddress().

void org::xmlBlaster::util::qos::ConnectQosData::addCbAddress ( org::xmlBlaster::util::qos::address::AddressBaseRef & cbAddress )

Parameters:

cbAddress

We take a copy of this so you can destroy your address after setting.

Note that if you work on your address object later it does not change the address in ConnectQos

Definition at line 202 of file ConnectQos.cpp.

References org::xmlBlaster::util::qos::storage::CbQueueProperty::setCallbackAddress().

AddressBaseRef org::xmlBlaster::util::qos::ConnectQosData::getCbAddress ( )

Definition at line 208 of file ConnectQos.cpp.

References org::xmlBlaster::util::qos::storage::CbQueueProperty::getCurrentCallbackAddress().

Referenced by SubscribeDemo::connect().

void org::xmlBlaster::util::qos::ConnectQosData::addClientQueueProperty ( org::xmlBlaster::util::qos::storage::ClientQueueProperty & prop )

Parameters:

prop

We take a copy of this so you can destroy your property after setting.

Note that if you work on your object later it does not change the setting in ConnectQos

Definition at line 219 of file ConnectQos.cpp.

Referenced by getClientQueueProperty().

ClientQueueProperty & org::xmlBlaster::util::qos::ConnectQosData::getClientQueueProperty ( )

Access the configuration settings of the client side queue and server address.

Returns:: If no instance exists it will be created on the fly and initialized with the current environment settings and command line arguments

Definition at line 224 of file ConnectQos.cpp.

References addClientQueueProperty().

Referenced by getAddress(), and setAddress().

void org::xmlBlaster::util::qos::ConnectQosData::setSessionCbQueueProperty ( org::xmlBlaster::util::qos::storage::CbQueueProperty & prop )

Parameters:

prop

We take a copy of this so you can destroy your property after setting.

Note that if you work on your object later it does not change the setting in ConnectQos

Definition at line 232 of file ConnectQos.cpp.

CbQueueProperty & org::xmlBlaster::util::qos::ConnectQosData::getSessionCbQueueProperty ( )

Access the configuration settings of the server side callback queue and callback address.

Returns:: If no instance exists it will be created on the fly and initialized with the current environment settings and command line arguments

Definition at line 237 of file ConnectQos.cpp.

Referenced by org::xmlBlaster::client::protocol::socket::SocketDriver::connect().

std::string org::xmlBlaster::util::qos::ConnectQosData::dumpClientProperties	(	std::string &	extraOffset,
		bool	clearText = `false`
	)

void org::xmlBlaster::util::qos::ConnectQosData::addClientProperty ( ClientProperty & clientProperty )

Add a client property.

Parameters:

clientProperty

See also:: ClientProperty

Definition at line 242 of file ConnectQos.cpp.

References clientProperties_, and org::xmlBlaster::util::qos::ClientProperty::getName().

template<typename T_VALUE>

void org::xmlBlaster::util::qos::ConnectQosData::addClientProperty	(	std::string &	name,
		T_VALUE &	value,
		std::string &	type = `""`,
		std::string &	encoding = `""`
	)