org::xmlBlaster::util::qos::SessionQosData

org::xmlBlaster::util::qos::SessionQosData Class Reference

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

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


Public Member Functions
virtual	~SessionQosData ()
	SessionQosData (org::xmlBlaster::util::Global &global, std::string &absoluteName="")
	When using this constructor you can let it assign the defaults by passing an empty std::string as the 'absoluteName' argument, or you force the SessionQos to set the SessionName to what you specify in the 'absoluteName' argument.
	SessionQosData (org::xmlBlaster::util::Global &global, std::string &defaultUserName, long publicSessionId)
	is the name to use as a default for the user (the subjectId).
	SessionQosData (SessionQosData &data)
SessionQosData &	operator= (SessionQosData &data)
long	getTimeout ()
void	setTimeout (long timeout)
int	getMaxSessions ()
void	setMaxSessions (int maxSessions)
bool	getClearSessions ()
void	setClearSessions (bool clearSessions)
bool	getReconnectSameClientOnly ()
void	setReconnectSameClientOnly (bool reconnectSameClientOnly)
void	setAbsoluteName (std::string &name)
	Sets the absolute name.
std::string	getRelativeName ()
std::string	getAbsoluteName ()
std::string	getClusterNodeId ()
void	setClusterNodeId (std::string &clusterNodeId)
std::string	getSubjectId ()
void	setSubjectId (std::string &subjectId)
long	getPubSessionId ()
void	setPubSessionId (long pubSessionId)
org::xmlBlaster::util::SessionNameRef	getSessionName ()
	Your changes outside change the internal sessionName.
std::string	getSecretSessionId ()
void	setSecretSessionId (std::string &sessionId)
std::string	toXml (std::string &extraOffset="")
Static Public Member Functions
static std::string	usage ()
	Get a usage string for the connection parameters.
Friends
class	SessionQosFactory

Detailed Description

Definition at line 32 of file SessionQos.h.

Constructor & Destructor Documentation

org::xmlBlaster::util::qos::SessionQosData::~SessionQosData ( ) [virtual]

Definition at line 42 of file SessionQos.cpp.

org::xmlBlaster::util::qos::SessionQosData::SessionQosData	(	org::xmlBlaster::util::Global &	global,
		std::string &	absoluteName = `""`
	)

When using this constructor you can let it assign the defaults by passing an empty std::string as the 'absoluteName' argument, or you force the SessionQos to set the SessionName to what you specify in the 'absoluteName' argument.

Parameters:

absoluteName

the sessionId to assign to this SessionQos. You can either pass an absolute name, or a relative name or an empty std::string.

org::xmlBlaster::util::qos::SessionQosData::SessionQosData	(	org::xmlBlaster::util::Global &	global,
		std::string &	defaultUserName,
		long	publicSessionId
	)

is the name to use as a default for the user (the subjectId).

It is stronger than the properties set but if an empty std::string is used, then the default name is taken from the 'user' property. This is just a default and as such it is weaker than the property 'session.name'. In other words, even if defaultUserName is not empty, it will be overwritten by eventual setting of the property 'session.name'.

is the public sessionId to be used. Note that this is just a suggestion, so if you have the 'session.name' property set, it will overwrite this. If the publicSessionId is '0', then it is omitted (the server will assign one for you).

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

Definition at line 70 of file SessionQos.cpp.

Member Function Documentation

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

Definition at line 76 of file SessionQos.cpp.

long org::xmlBlaster::util::qos::SessionQosData::getTimeout ( )

Definition at line 133 of file SessionQos.cpp.

Referenced by org::xmlBlaster::test::TestQos::testSessionQos().

void org::xmlBlaster::util::qos::SessionQosData::setTimeout ( long timeout )

Definition at line 138 of file SessionQos.cpp.

int org::xmlBlaster::util::qos::SessionQosData::getMaxSessions ( )

Definition at line 143 of file SessionQos.cpp.

Referenced by org::xmlBlaster::test::TestQos::testSessionQos().

void org::xmlBlaster::util::qos::SessionQosData::setMaxSessions ( int maxSessions )

Definition at line 148 of file SessionQos.cpp.

bool org::xmlBlaster::util::qos::SessionQosData::getClearSessions ( )

Definition at line 153 of file SessionQos.cpp.

Referenced by org::xmlBlaster::test::TestQos::testSessionQos().

void org::xmlBlaster::util::qos::SessionQosData::setClearSessions ( bool clearSessions )

Definition at line 158 of file SessionQos.cpp.

bool org::xmlBlaster::util::qos::SessionQosData::getReconnectSameClientOnly ( )

Definition at line 163 of file SessionQos.cpp.

Referenced by org::xmlBlaster::test::TestQos::testSessionQos().

void org::xmlBlaster::util::qos::SessionQosData::setReconnectSameClientOnly ( bool reconnectSameClientOnly )

Definition at line 168 of file SessionQos.cpp.

void org::xmlBlaster::util::qos::SessionQosData::setAbsoluteName ( std::string & name )

Sets the absolute name.

Note that you can overwrite the nodeId here. It returns 'true' if the name was absolute, 'false' otherwise. This is a convenience access for getSessionName()->setAbsoluteName(name)

Referenced by org::xmlBlaster::util::EmbeddedServer::isSomeServerResponding(), and org::xmlBlaster::test::TestDoubleGlobal::sessionQos().

string org::xmlBlaster::util::qos::SessionQosData::getRelativeName ( )

Definition at line 93 of file SessionQos.cpp.

Referenced by org::xmlBlaster::test::TestFailsafe::testReconnect().

string org::xmlBlaster::util::qos::SessionQosData::getAbsoluteName ( )

Definition at line 98 of file SessionQos.cpp.

Referenced by org::xmlBlaster::client::XmlBlasterAccess::connect(), org::xmlBlaster::test::TestDoubleGlobal::sessionQos(), org::xmlBlaster::test::TestSub::setUp(), org::xmlBlaster::test::TestLeaveServer::setUp(), org::xmlBlaster::test::TestCommand::setUp(), org::xmlBlaster::test::TestConnectQos::testSessionQos(), and org::xmlBlaster::test::TestSub::update().

string org::xmlBlaster::util::qos::SessionQosData::getClusterNodeId ( )

Definition at line 103 of file SessionQos.cpp.

Referenced by org::xmlBlaster::test::TestQos::testSessionQos().

void org::xmlBlaster::util::qos::SessionQosData::setClusterNodeId ( std::string & clusterNodeId )