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 UM_DEPRECATED nSession *	createMultiplexed (nSession *pSession)
	Creation of multiplexed session is not supported in C#/C++ API. More...

static UM_DEPRECATED nSession *	createMultiplexed (nSessionAttributes *sessionAttributes)
	Creation of multiplexed session is not supported in C#/C++ API. More...

static UM_DEPRECATED nSession *	createMultiplexed (nSessionAttributes *sessionAttributes, std::string userName)
	Creation of multiplexed session is not supported in C#/C++ API. 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 UM_DEPRECATED nSession* com::pcbsys::nirvana::client::nSessionFactory::createMultiplexed ( nSession * pSession )

static

Creation of multiplexed session is not supported in C#/C++ API.

A standard session is created instead based on the nSessionAttributes object contained in the passed session and the supplied credentials

Parameters

pSession this session attributes will be used to create new standard session

Returns: new standard session

Deprecated:: Creation of multiplexed sessions is deprecated since 10.7 and will be removed in future releases. Standard sessions should be used instead

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

static

Creation of multiplexed session is not supported in C#/C++ API.

A standard session is created instead based on the nSessionAttributes object

Parameters

sessionAttributes the nSessionAttributes object containing the parameters for the session to be created

Returns: new standard session

Deprecated:: Creation of multiplexed sessions is deprecated since 10.7 and will be removed in future releases. Standard sessions should be used instead

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

static

Creation of multiplexed session is not supported in C#/C++ API.

A standard session is created instead based on the nSessionAttributes object and the provided username

Parameters

sessionAttributes	the nSessionAttributes object containing the parameters for the session to be created
userName	the user name to be used by this session to authenticate

Returns: new standard session

Deprecated:: Creation of multiplexed sessions is deprecated since 10.7 and will be removed in future releases. Standard sessions should be used instead

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