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

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::SessionControlPrx:

Collaboration diagram for Glacier2::SessionControlPrx:

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

::std::function< void()>	adapterIdsAsync (::std::function< void(::std::shared_ptr<::Glacier2::StringSetPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Access the object that manages the allowable adapter identities for objects for this session. More...

template<template< typename > class P = ::std::promise>
auto	adapterIdsAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Glacier2::StringSetPrx >>>().get_future())
	Access the object that manages the allowable adapter identities for objects for this session. More...

::std::shared_ptr< StringSetPrx >	categories (const ::Ice::Context &context=::Ice::noExplicitContext)
	Access the object that manages the allowable categories for object identities for this session. More...

::std::function< void()>	categoriesAsync (::std::function< void(::std::shared_ptr<::Glacier2::StringSetPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Access the object that manages the allowable categories for object identities for this session. More...

template<template< typename > class P = ::std::promise>
auto	categoriesAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Glacier2::StringSetPrx >>>().get_future())
	Access the object that manages the allowable categories for object identities for this session. More...

void	destroy (const ::Ice::Context &context=::Ice::noExplicitContext)
	Destroy the associated session. More...

::std::function< void()>	destroyAsync (::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Destroy the associated session. More...

template<template< typename > class P = ::std::promise>
auto	destroyAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Destroy the associated session. More...

int	getSessionTimeout (const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the session timeout. More...

::std::function< void()>	getSessionTimeoutAsync (::std::function< void(int)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the session timeout. More...

template<template< typename > class P = ::std::promise>
auto	getSessionTimeoutAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< int >>().get_future())
	Get the session timeout. More...

::std::shared_ptr< IdentitySetPrx >	identities (const ::Ice::Context &context=::Ice::noExplicitContext)
	Access the object that manages the allowable object identities for this session. More...

::std::function< void()>	identitiesAsync (::std::function< void(::std::shared_ptr<::Glacier2::IdentitySetPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Access the object that manages the allowable object identities for this session. More...

template<template< typename > class P = ::std::promise>
auto	identitiesAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Glacier2::IdentitySetPrx >>>().get_future())
	Access the object that manages the allowable object identities for this session. More...

Public Member Functions inherited from Ice::Proxy< SessionControlPrx, ::Ice::ObjectPrx >
::std::shared_ptr< SessionControlPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID. More...

::std::shared_ptr< SessionControlPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

::std::shared_ptr< SessionControlPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...

::std::shared_ptr< SessionControlPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...

::std::shared_ptr< SessionControlPrx >	ice_compress (bool b) const
	Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...

::std::shared_ptr< SessionControlPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< SessionControlPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID. More...

::std::shared_ptr< SessionControlPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...

::std::shared_ptr< SessionControlPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< SessionControlPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...

::std::shared_ptr< SessionControlPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< SessionControlPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...

::std::shared_ptr< SessionControlPrx >	ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...

::std::shared_ptr< SessionControlPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< SessionControlPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator. More...

::std::shared_ptr< SessionControlPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

::std::shared_ptr< SessionControlPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...

::std::shared_ptr< SessionControlPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...

::std::shared_ptr< SessionControlPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router. More...

::std::shared_ptr< SessionControlPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< SessionControlPrx >	ice_timeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...

::std::shared_ptr< SessionControlPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

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

Detailed Description

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

See also: Session

Member Function Documentation

◆ adapterIds()

::std::shared_ptr<StringSetPrx> Glacier2::SessionControlPrx::adapterIds ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

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

Parameters

context The Context map to send with the invocation.

Returns: A StringSet object.

◆ adapterIdsAsync() [1/2]

::std::function<void()> Glacier2::SessionControlPrx::adapterIdsAsync	(	::std::function< void(::std::shared_ptr<::Glacier2::StringSetPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ adapterIdsAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Glacier2::SessionControlPrx::adapterIdsAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<::std::shared_ptr<::Glacier2::StringSetPrx>>>().get_future())

inline

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

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ categories()

::std::shared_ptr<StringSetPrx> Glacier2::SessionControlPrx::categories ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

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

Parameters

context The Context map to send with the invocation.

Returns: A StringSet object.

◆ categoriesAsync() [1/2]

::std::function<void()> Glacier2::SessionControlPrx::categoriesAsync	(	::std::function< void(::std::shared_ptr<::Glacier2::StringSetPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ categoriesAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Glacier2::SessionControlPrx::categoriesAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<::std::shared_ptr<::Glacier2::StringSetPrx>>>().get_future())

inline

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

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ destroy()

void Glacier2::SessionControlPrx::destroy ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Destroy the associated session.

Parameters

context The Context map to send with the invocation.

◆ destroyAsync() [1/2]

::std::function<void()> Glacier2::SessionControlPrx::destroyAsync	(	::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Destroy the associated session.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ destroyAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Glacier2::SessionControlPrx::destroyAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<void>>().get_future())

inline

Destroy the associated session.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ getSessionTimeout()

int Glacier2::SessionControlPrx::getSessionTimeout ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Get the session timeout.

Parameters

context The Context map to send with the invocation.

Returns: The timeout.

◆ getSessionTimeoutAsync() [1/2]

::std::function<void()> Glacier2::SessionControlPrx::getSessionTimeoutAsync	(	::std::function< void(int)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Get the session timeout.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ getSessionTimeoutAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Glacier2::SessionControlPrx::getSessionTimeoutAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<int>>().get_future())

inline

Get the session timeout.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ ice_staticId()

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

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

◆ identities()

::std::shared_ptr<IdentitySetPrx> Glacier2::SessionControlPrx::identities ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

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

Parameters

context The Context map to send with the invocation.

Returns: An IdentitySet object.

◆ identitiesAsync() [1/2]

::std::function<void()> Glacier2::SessionControlPrx::identitiesAsync	(	::std::function< void(::std::shared_ptr<::Glacier2::IdentitySetPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ identitiesAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Glacier2::SessionControlPrx::identitiesAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<::std::shared_ptr<::Glacier2::IdentitySetPrx>>>().get_future())

inline

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

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ adapterIds()

◆ adapterIdsAsync() [1/2]

◆ adapterIdsAsync() [2/2]

◆ categories()

◆ categoriesAsync() [1/2]

◆ categoriesAsync() [2/2]

◆ destroy()

◆ destroyAsync() [1/2]

◆ destroyAsync() [2/2]

◆ getSessionTimeout()

◆ getSessionTimeoutAsync() [1/2]

◆ getSessionTimeoutAsync() [2/2]

◆ ice_staticId()

◆ identities()

◆ identitiesAsync() [1/2]

◆ identitiesAsync() [2/2]