A session object is used by IceGrid clients to allocate and release objects. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::Session:

[legend]

Collaboration diagram for IceGrid::Session:

[legend]

Public Types
using	ProxyType = SessionPrx
Public Types inherited from Glacier2::Session
using	ProxyType = SessionPrx

Public Member Functions
virtual void	allocateObjectByIdAsync (::Ice::Identity id, ::std::function< void(const ::std::shared_ptr<::Ice::ObjectPrx > &returnValue)> response, ::std::function< void(::std::exception_ptr)> exception, const ::Ice::Current &current)=0
	Allocate an object.
virtual void	allocateObjectByTypeAsync (::std::string type, ::std::function< void(const ::std::shared_ptr<::Ice::ObjectPrx > &returnValue)> response, ::std::function< void(::std::exception_ptr)> exception, const ::Ice::Current &current)=0
	Allocate an object with the given type.
virtual::std::string	ice_id (const ::Ice::Current &current) const override
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector<::std::string >	ice_ids (const ::Ice::Current &current) const override
	Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool	ice_isA (::std::string id, const ::Ice::Current &current) const override
	Determines whether this object supports an interface with the given Slice type ID.
virtual void	keepAlive (const ::Ice::Current &current)=0
	Keep the session alive.
virtual void	releaseObject (::Ice::Identity id, const ::Ice::Current &current)=0
	Release an object that was allocated using `allocateObjectById` or `allocateObjectByType`.
virtual void	setAllocationTimeout (int timeout, const ::Ice::Current &current)=0
	Set the allocation timeout.
Public Member Functions inherited from Glacier2::Session
virtual void	destroy (const ::Ice::Current &current)=0
	Destroy the session.
virtual::std::string	ice_id (const ::Ice::Current &current) const override
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector<::std::string >	ice_ids (const ::Ice::Current &current) const override
	Obtains a list of the Slice type IDs representing the interfaces supported by this object.
Public Member Functions inherited from Ice::Object
virtual bool	ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
	Dispatches an invocation to a servant.
virtual std::string	ice_id (const Current &current) const
	Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string >	ice_ids (const Current &current) const
	Returns the Slice type IDs of the interfaces supported by this object.
virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface.
virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached.
virtual	~Object ()=default

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Glacier2::Session
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type.

Detailed Description

A session object is used by IceGrid clients to allocate and release objects.

Client sessions are created either via the Registry object or via the registry client SessionManager object.

See also: Registry

Member Typedef Documentation

◆ ProxyType

using IceGrid::Session::ProxyType = SessionPrx

Member Function Documentation

◆ allocateObjectByIdAsync()

virtual void IceGrid::Session::allocateObjectByIdAsync	(	::Ice::Identity	id,
		::std::function< void(const ::std::shared_ptr<::Ice::ObjectPrx > &returnValue)>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const ::Ice::Current &	current )

pure virtual

Allocate an object.

Depending on the allocation timeout, this operation might hang until the object is available or until the timeout is reached.

Parameters

id	The identity of the object to allocate.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

IceGrid::AllocationException	Raised if the object can't be allocated.
IceGrid::ObjectNotRegisteredException	Raised if the object with the given identity is not registered with the registry.

See also: setAllocationTimeout; releaseObject

◆ allocateObjectByTypeAsync()

virtual void IceGrid::Session::allocateObjectByTypeAsync	(	::std::string	type,
		::std::function< void(const ::std::shared_ptr<::Ice::ObjectPrx > &returnValue)>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const ::Ice::Current &	current )

pure virtual

Allocate an object with the given type.

Depending on the allocation timeout, this operation can block until an object becomes available or until the timeout is reached.

Parameters

type	The type of the object.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

IceGrid::AllocationException Raised if the object could not be allocated.

See also: setAllocationTimeout; releaseObject

◆ ice_id()

virtual::std::string IceGrid::Session::ice_id ( const ::Ice::Current & current ) const

override

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current The Current object for the invocation.

Returns: A fully-scoped type ID.

◆ ice_ids()

virtual ::std::vector<::std::string > IceGrid::Session::ice_ids ( const ::Ice::Current & current ) const

override

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current The Current object for the invocation.

Returns: A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceGrid::Session::ice_isA	(	::std::string	id,
		const ::Ice::Current &	current ) const

overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns: True if this object supports the interface, false, otherwise.

Reimplemented from Glacier2::Session.

◆ ice_staticId()

const ::std::string & IceGrid::Session::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

◆ keepAlive()

virtual void IceGrid::Session::keepAlive ( const ::Ice::Current & current )

pure virtual

Keep the session alive.

Clients should call this operation regularly to prevent the server from reaping the session.

Parameters

current The Current object for the invocation.

See also: Registry::getSessionTimeout

◆ releaseObject()

virtual void IceGrid::Session::releaseObject	(	::Ice::Identity	id,
		const ::Ice::Current &	current )

pure virtual

Release an object that was allocated using allocateObjectById or allocateObjectByType.

Parameters

id	The identity of the object to release.
current	The Current object for the invocation.

Exceptions

IceGrid::AllocationException	Raised if the given object can't be released. This might happen if the object isn't allocatable or isn't allocated by the session.
IceGrid::ObjectNotRegisteredException	Raised if the object with the given identity is not registered with the registry.

◆ setAllocationTimeout()

virtual void IceGrid::Session::setAllocationTimeout	(	int	timeout,
		const ::Ice::Current &	current )

pure virtual

Set the allocation timeout.

If no objects are available for an allocation request, a call to allocateObjectById or allocateObjectByType will block for the duration of this timeout.

Parameters

timeout	The timeout in milliseconds.
current	The Current object for the invocation.

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

generated/cpp11/x64/Release/IceGrid/Session.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ allocateObjectByIdAsync()

◆ allocateObjectByTypeAsync()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

◆ keepAlive()

◆ releaseObject()

◆ setAllocationTimeout()