An administrative session control object, which is tied to the lifecycle of a Session. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::SessionControl:

Collaboration diagram for Glacier2::SessionControl:

Public Types
using	ProxyType = SessionControlPrx

Public Member Functions
virtual ::std::shared_ptr< StringSetPrx >	adapterIds (const ::Ice::Current &current)=0
	Access the object that manages the allowable adapter identities for objects for this session. More...

virtual ::std::shared_ptr< StringSetPrx >	categories (const ::Ice::Current &current)=0
	Access the object that manages the allowable categories for object identities for this session. More...

virtual void	destroy (const ::Ice::Current &current)=0
	Destroy the associated session. More...

virtual int	getSessionTimeout (const ::Ice::Current &current)=0
	Get the session timeout. More...

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. More...

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. More...

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. More...

virtual ::std::shared_ptr< IdentitySetPrx >	identities (const ::Ice::Current &current)=0
	Access the object that manages the allowable object identities for this session. More...

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. More...

virtual std::string	ice_id (const Current &current) const
	Returns the Slice type ID of the most-derived interface supported by this object. More...

virtual std::vector< std::string >	ice_ids (const Current &current) const
	Returns the Slice type IDs of the interfaces supported by this object. More...

virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface. More...

virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached. More...

virtual	~Object ()=default

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class. More...

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

Detailed Description

An administrative session control object, which is tied to the lifecycle of a Session.

See also: Session

Member Typedef Documentation

◆ ProxyType

using Glacier2::SessionControl::ProxyType = SessionControlPrx

Member Function Documentation

◆ adapterIds()

virtual ::std::shared_ptr<StringSetPrx> Glacier2::SessionControl::adapterIds ( const ::Ice::Current & current )

pure virtual

Access the object that manages the allowable adapter identities for objects for this session.

Parameters

current The Current object for the invocation.

Returns: A StringSet object.

◆ categories()

virtual ::std::shared_ptr<StringSetPrx> Glacier2::SessionControl::categories ( const ::Ice::Current & current )

pure virtual

Access the object that manages the allowable categories for object identities for this session.

Parameters

current The Current object for the invocation.

Returns: A StringSet object.

◆ destroy()

virtual void Glacier2::SessionControl::destroy ( const ::Ice::Current & current )

pure virtual

Destroy the associated session.

Parameters

current The Current object for the invocation.

◆ getSessionTimeout()

virtual int Glacier2::SessionControl::getSessionTimeout ( const ::Ice::Current & current )

pure virtual

Get the session timeout.

Parameters

current The Current object for the invocation.

Returns: The timeout.

◆ ice_id()

virtual ::std::string Glacier2::SessionControl::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> Glacier2::SessionControl::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 Glacier2::SessionControl::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.

◆ ice_staticId()

static const ::std::string& Glacier2::SessionControl::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

◆ identities()

virtual ::std::shared_ptr<IdentitySetPrx> Glacier2::SessionControl::identities ( const ::Ice::Current & current )

pure virtual

Access the object that manages the allowable object identities for this session.

Parameters

current The Current object for the invocation.

Returns: An IdentitySet object.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ adapterIds()

◆ categories()

◆ destroy()

◆ getSessionTimeout()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

◆ identities()