Glacier2::SessionHelper Class Reference

Encapsulates a Glacier2 session and provides much of the same functionality as Glacier2::Application but better suited for graphical applications. More...

#include <Glacier2/Glacier2.h>

Public Member Functions
virtual Ice::ObjectPrxPtr	addWithUUID (const Ice::ObjectPtr &servant)=0
	Adds a servant to the callback object adapter using a UUID for the identity name.
virtual std::string	categoryForClient () const =0
	Obtains the category that must be used in the identities of all callback objects.
virtual Ice::CommunicatorPtr	communicator () const =0
	Obtains the communicator created by the SessionHelper.
virtual void	destroy ()=0
	Initiates the destruction of the Glacier2 session, including the communicator created by the SessionHelper.
virtual bool	isConnected () const =0
	Determines whether the session is active.
virtual Ice::ObjectAdapterPtr	objectAdapter ()=0
	Obtains the callback object adapter.
virtual SessionPrxPtr	session () const =0
	Obtains a proxy for the Glacier2 session.
virtual	~SessionHelper ()

Detailed Description

Encapsulates a Glacier2 session and provides much of the same functionality as Glacier2::Application but better suited for graphical applications.

Constructor & Destructor Documentation

~SessionHelper()

virtual Glacier2::SessionHelper::~SessionHelper ( )

virtual

Member Function Documentation

addWithUUID()

virtual Ice::ObjectPrxPtr Glacier2::SessionHelper::addWithUUID ( const Ice::ObjectPtr & servant )

pure virtual

Adds a servant to the callback object adapter using a UUID for the identity name.

Also see Ice::ObjectAdapter::addWithUUID.

Parameters

servant

The servant to add to the callback object adapter's active servant table.

Returns

A proxy for the object.

Exceptions

SessionNotExistException

if no session is currently active.

categoryForClient()

virtual std::string Glacier2::SessionHelper::categoryForClient ( ) const

pure virtual

Obtains the category that must be used in the identities of all callback objects.

Returns

The identity category.

Exceptions

SessionNotExistException

if no session is currently active.

communicator()

virtual Ice::CommunicatorPtr Glacier2::SessionHelper::communicator ( ) const

pure virtual

Obtains the communicator created by the SessionHelper.

Returns

The communicator object.

Exceptions

SessionNotExistException

if no session is currently active.

destroy()

virtual void Glacier2::SessionHelper::destroy ( )

pure virtual

Initiates the destruction of the Glacier2 session, including the communicator created by the SessionHelper.

isConnected()

virtual bool Glacier2::SessionHelper::isConnected ( ) const

pure virtual

Determines whether the session is active.

Returns

True if the session is currently active, false otherwise.

objectAdapter()

virtual Ice::ObjectAdapterPtr Glacier2::SessionHelper::objectAdapter ( )

pure virtual

Obtains the callback object adapter.

This object adapter is only created if the session factory was configured to do so using SessionFactoryHelper::setUseCallbacks.

Returns

The object adapter, or nil if no object adapter was created.

Exceptions

SessionNotExistException

if no session is currently active.

session()

virtual SessionPrxPtr Glacier2::SessionHelper::session ( ) const

pure virtual

Obtains a proxy for the Glacier2 session.

Returns

The session proxy, or a nil proxy if no session is currently active.

---

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

• Glacier2/SessionHelper.h