This class is used with a nSessionAttributes object to create a Nirvana session. More...

#include <nSessionFactory.h>

Static Public Member Functions
static void	close (nSession *pSession)
	Closes a Nirvana session. More...

static nSession *	create (nSessionAttributes *pAttr)
	Creates an nSession object (Nirvana session) based on the nSessionAttributes object supplied. More...

static nSession *	create (nSessionAttributes *pAttr, std::string &name)
	Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler. More...

static nSession *	create (nSessionAttributes pAttr, nReconnectHandler pHandler)
	Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler. More...

static nSession *	create (nSessionAttributes pAttr, nReconnectHandler pHandler, std::string &userName)
	Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler. More...

static nSession *	createMultiplexed (nSession *pSession)
	Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed. More...

static nSession *	createMultiplexed (nSessionAttributes *sessionAttributes)
	Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed. More...

static nSession *	createMultiplexed (nSessionAttributes *sessionAttributes, std::string userName)
	Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed. More...

static int	getNoVended ()
	Gets the number of nirvana sessions vended. More...

static void	shutdown (bool closeAllThreads=false)
	Shuts down the session factory by closing all nirvana sessions that have been created. More...

Detailed Description

This class is used with a nSessionAttributes object to create a Nirvana session.

Member Function Documentation

static void com::pcbsys::nirvana::client::nSessionFactory::close ( nSession * pSession )

static

Closes a Nirvana session.

Parameters

*pSession The nSession object to be closed

Exceptions

nIllegalArgumentException if the nSession is invalid

static nSession* com::pcbsys::nirvana::client::nSessionFactory::create ( nSessionAttributes * pAttr )

static

Creates an nSession object (Nirvana session) based on the nSessionAttributes object supplied.

Parameters

*pAttr The nSessionAttributes object containing the parameters for the session to be created

Returns: the newly created nSession object

Exceptions

nIllegalArgumentException if the nSessionAttributes is invalid

static nSession* com::pcbsys::nirvana::client::nSessionFactory::create	(	nSessionAttributes *	pAttr,
		std::string &	name
	)

static

Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler.

Parameters

*pAttr	The nSessionAttributes object containing the parameters for the session to be created
name	The user name to be used by this session to authenticate

Returns: the newly created nSession object

Exceptions

nIllegalArgumentException if the nSessionAttributes is invalid or the username

static nSession* com::pcbsys::nirvana::client::nSessionFactory::create	(	nSessionAttributes *	pAttr,
		nReconnectHandler *	pHandler
	)

static

Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler.

Parameters

*pAttr	The nSessionAttributes object containing the parameters for the session to be created
*pHandler	A nReconnectHandler to use if the connection to the Server is lost

Returns: the newly created nSession object

Exceptions

nIllegalArgumentException if the nSessionAttributes is invalid

static nSession* com::pcbsys::nirvana::client::nSessionFactory::create	(	nSessionAttributes *	pAttr,
		nReconnectHandler *	pHandler,
		std::string &	userName
	)

static

Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler.

Parameters

*pAttr	The nSessionAttributes object containing the parameters for the session to be created
*pHandler	A nReconnectHandler to use if the connection to the Server is lost
userName	A String token to use when authenticating with the server

Returns: the newly created nSession object

Exceptions

nIllegalArgumentException if the nSessionAttributes is invalid

See Also: nReconnectHandler

static nSession* com::pcbsys::nirvana::client::nSessionFactory::createMultiplexed ( nSession * pSession )

static

Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed.

Allows applications to subscribe twice to the same channel or queue using different filters, or reduce the impact of any connection limits imposed by any browser / host machine to specific hosts, since the connection count will only ever be 1.

Parameters

pSession the session with which to multiplex the connection

Returns: a multiplexed session

static nSession* com::pcbsys::nirvana::client::nSessionFactory::createMultiplexed ( nSessionAttributes * sessionAttributes )

static

Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed.

Allows applications to subscribe twice to the same channel or queue using different filters, or reduce the impact of any connection limits imposed by any browser / host machine to specific hosts, since the connection count will only ever be 1.

Parameters

sessionAttributes the sessionAttributes of the session with which to multiplex the connection

Returns: a multiplexed session

static nSession* com::pcbsys::nirvana::client::nSessionFactory::createMultiplexed	(	nSessionAttributes *	sessionAttributes,
		std::string	userName
	)

static

Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed.

Allows applications to subscribe twice to the same channel or queue using different filters, or reduce the impact of any connection limits imposed by any browser / host machine to specific hosts, since the connection count will only ever be 1.

Parameters

sessionAttributes	the sessionAttributes of the session with which to multiplex the connection
userName	the user name used when no physical connection exists to the desired realm

Returns: a multiplexed session

static int com::pcbsys::nirvana::client::nSessionFactory::getNoVended ( )

static

Gets the number of nirvana sessions vended.

Returns: an int specifying the number of nirvana sessions vended with this session factory

static void com::pcbsys::nirvana::client::nSessionFactory::shutdown ( bool closeAllThreads = false )

static

Shuts down the session factory by closing all nirvana sessions that have been created.

Static Public Member Functions

Detailed Description

Member Function Documentation