Glacier2::SessionFactoryHelper Class Reference

Facilitates the creation of new Glacier2 sessions. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::SessionFactoryHelper:

Collaboration diagram for Glacier2::SessionFactoryHelper:

Public Member Functions
SessionHelperPtr	connect ()
	Initializes a communicator, creates a Glacier2 session using SSL credentials, and returns a new SessionHelper object.
SessionHelperPtr	connect (const std::string &username, const std::string &password)
	Initializes a communicator, creates a Glacier2 session using the given username and password, and returns a new SessionHelper object.
void	destroy ()
	Blocks until all background threads are terminated.
Ice::InitializationData	getInitializationData () const
	Returns a copy of the InitializationData object that will be used during communicator initialization.
int	getPort () const
	Obtains the port on which the Glacier2 router is listening.
std::string	getProtocol () const
	Obtains the Ice protocol used for communications with the Glacier2 router.
std::string	getRouterHost () const
	Obtains the host name of the Glacier2 router.
Ice::Identity	getRouterIdentity () const
	Obtains the object identity of the Glacier2 router.
int	getTimeout () const
	Obtains the timeout in milliseconds for the connection to the Glacier2 router.
bool	getUseCallbacks () const
	Determines whether the session helper automatically creates an object adapter for callback servants.
	SessionFactoryHelper (const Ice::InitializationData &initData, const SessionCallbackPtr &callback)
	Use this constructor when you want to provide your own instance of InitializationData.
	SessionFactoryHelper (const Ice::PropertiesPtr &properties, const SessionCallbackPtr &callback)
	This constructor is convenient when you want to supply an initial set of properties.
	SessionFactoryHelper (const SessionCallbackPtr &callback)
	This constructor is useful when your application has no other configuration requirements.
void	setConnectContext (const std::map< std::string, std::string > &context)
	Sets the request context to be used when creating a session.
void	setPort (int port)
	Sets the port on which the Glacier2 router is listening.
void	setProtocol (const std::string &protocol)
	Sets the Ice protocol used for communications with the Glacier2 router.
void	setRouterHost (const std::string &host)
	Sets the host name of the Glacier2 router.
void	setRouterIdentity (const Ice::Identity &identity)
	Sets the object identity of the Glacier2 router.
void	setTimeout (int timeout)
	Sets the timeout in milliseconds for the connection to the Glacier2 router.
void	setUseCallbacks (bool b)
	Determines whether the session helper automatically creates an object adapter for callback servants.
	~SessionFactoryHelper ()

Detailed Description

Facilitates the creation of new Glacier2 sessions.

Constructor & Destructor Documentation

SessionFactoryHelper() [1/3]

Glacier2::SessionFactoryHelper::SessionFactoryHelper

(

const SessionCallbackPtr &

callback

)

This constructor is useful when your application has no other configuration requirements.

The constructor allocates an InitializationData object and a new property set.

Parameters

callback

The callback object (must not be nil).

SessionFactoryHelper() [2/3]

Glacier2::SessionFactoryHelper::SessionFactoryHelper	(	const Ice::InitializationData &	initData,
		const SessionCallbackPtr &	callback )

Use this constructor when you want to provide your own instance of InitializationData.

Parameters

initData	Initialization data for the communicator.
callback	The callback object (must not be nil).

SessionFactoryHelper() [3/3]

Glacier2::SessionFactoryHelper::SessionFactoryHelper	(	const Ice::PropertiesPtr &	properties,
		const SessionCallbackPtr &	callback )

This constructor is convenient when you want to supply an initial set of properties.

Parameters

properties	Configuration properties for the communicator.
callback	The callback object (must not be nil).

~SessionFactoryHelper()

Glacier2::SessionFactoryHelper::~SessionFactoryHelper

(

)

Member Function Documentation

connect() [1/2]

SessionHelperPtr Glacier2::SessionFactoryHelper::connect

(

)

Initializes a communicator, creates a Glacier2 session using SSL credentials, and returns a new SessionHelper object.

connect() [2/2]

SessionHelperPtr Glacier2::SessionFactoryHelper::connect	(	const std::string &	username,
		const std::string &	password )

Initializes a communicator, creates a Glacier2 session using the given username and password, and returns a new SessionHelper object.

destroy()

void Glacier2::SessionFactoryHelper::destroy

(

)

Blocks until all background threads are terminated.

getInitializationData()

Ice::InitializationData Glacier2::SessionFactoryHelper::getInitializationData

(

)

const

Returns a copy of the InitializationData object that will be used during communicator initialization.

Returns

The communicator initialization data.

getPort()

int Glacier2::SessionFactoryHelper::getPort

(

)

const

Obtains the port on which the Glacier2 router is listening.

Returns

The router port.

getProtocol()

std::string Glacier2::SessionFactoryHelper::getProtocol

(

)

const

Obtains the Ice protocol used for communications with the Glacier2 router.

Returns

The protocol name.

getRouterHost()

std::string Glacier2::SessionFactoryHelper::getRouterHost

(

)

const

Obtains the host name of the Glacier2 router.

Returns

The router host name.

getRouterIdentity()

Ice::Identity Glacier2::SessionFactoryHelper::getRouterIdentity

(

)

const

Obtains the object identity of the Glacier2 router.

Returns

The router identity.

getTimeout()

int Glacier2::SessionFactoryHelper::getTimeout

(

)

const

Obtains the timeout in milliseconds for the connection to the Glacier2 router.

Returns

The timeout in milliseconds.

getUseCallbacks()

bool Glacier2::SessionFactoryHelper::getUseCallbacks

(

)

const

Determines whether the session helper automatically creates an object adapter for callback servants.

Returns

True if the helper will create an object adapter, false otherwise.

setConnectContext()

void Glacier2::SessionFactoryHelper::setConnectContext

(

const std::map< std::string, std::string > &

context

)

Sets the request context to be used when creating a session.

Parameters

context

The request context.

setPort()

void Glacier2::SessionFactoryHelper::setPort

(

int

port

)

Sets the port on which the Glacier2 router is listening.

Parameters

port	The router port.

setProtocol()

void Glacier2::SessionFactoryHelper::setProtocol

(

const std::string &

protocol

)

Sets the Ice protocol used for communications with the Glacier2 router.

Parameters

protocol

The protocol name (e.g., "tcp").

setRouterHost()

void Glacier2::SessionFactoryHelper::setRouterHost

(

const std::string &

host

)

Sets the host name of the Glacier2 router.

Parameters

host	The router host name.

setRouterIdentity()

void Glacier2::SessionFactoryHelper::setRouterIdentity

(

const Ice::Identity &

identity

)

Sets the object identity of the Glacier2 router.

Parameters

identity

The router identity.

setTimeout()

void Glacier2::SessionFactoryHelper::setTimeout

(

int

timeout

)

Sets the timeout in milliseconds for the connection to the Glacier2 router.

Parameters

timeout

The timeout in milliseconds.

setUseCallbacks()

void Glacier2::SessionFactoryHelper::setUseCallbacks

(

bool

b

)

Determines whether the session helper automatically creates an object adapter for callback servants.

Parameters

b	True if the helper should create an object adapter, false otherwise.

---

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

• Glacier2/SessionHelper.h