The IceGrid registry allows clients create sessions directly with the registry. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::RegistryPrx:

Collaboration diagram for IceGrid::RegistryPrx:

Public Member Functions
::std::shared_ptr< AdminSessionPrx >	createAdminSession (const ::std::string &userId, const ::std::string &password, const ::Ice::Context &context=::Ice::noExplicitContext)
	Create an administrative session. More...

::std::function< void()>	createAdminSessionAsync (const ::std::string &userId, const ::std::string &password, ::std::function< void(::std::shared_ptr<::IceGrid::AdminSessionPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Create an administrative session. More...

template<template< typename > class P = ::std::promise>
auto	createAdminSessionAsync (const ::std::string &userId, const ::std::string &password, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::IceGrid::AdminSessionPrx >>>().get_future())
	Create an administrative session. More...

::std::shared_ptr< AdminSessionPrx >	createAdminSessionFromSecureConnection (const ::Ice::Context &context=::Ice::noExplicitContext)
	Create an administrative session from a secure connection. More...

::std::function< void()>	createAdminSessionFromSecureConnectionAsync (::std::function< void(::std::shared_ptr<::IceGrid::AdminSessionPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Create an administrative session from a secure connection. More...

template<template< typename > class P = ::std::promise>
auto	createAdminSessionFromSecureConnectionAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::IceGrid::AdminSessionPrx >>>().get_future())
	Create an administrative session from a secure connection. More...

::std::shared_ptr< SessionPrx >	createSession (const ::std::string &userId, const ::std::string &password, const ::Ice::Context &context=::Ice::noExplicitContext)
	Create a client session. More...

::std::function< void()>	createSessionAsync (const ::std::string &userId, const ::std::string &password, ::std::function< void(::std::shared_ptr<::IceGrid::SessionPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Create a client session. More...

template<template< typename > class P = ::std::promise>
auto	createSessionAsync (const ::std::string &userId, const ::std::string &password, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::IceGrid::SessionPrx >>>().get_future())
	Create a client session. More...

::std::shared_ptr< SessionPrx >	createSessionFromSecureConnection (const ::Ice::Context &context=::Ice::noExplicitContext)
	Create a client session from a secure connection. More...

::std::function< void()>	createSessionFromSecureConnectionAsync (::std::function< void(::std::shared_ptr<::IceGrid::SessionPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Create a client session from a secure connection. More...

template<template< typename > class P = ::std::promise>
auto	createSessionFromSecureConnectionAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::IceGrid::SessionPrx >>>().get_future())
	Create a client session from a secure connection. More...

int	getACMTimeout (const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the value of the ACM timeout. More...

::std::function< void()>	getACMTimeoutAsync (::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 value of the ACM timeout. More...

template<template< typename > class P = ::std::promise>
auto	getACMTimeoutAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< int >>().get_future())
	Get the value of the ACM timeout. 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...

Public Member Functions inherited from Ice::Proxy< RegistryPrx, ::Ice::ObjectPrx >
::std::shared_ptr< RegistryPrx >	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< RegistryPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

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

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

::std::shared_ptr< RegistryPrx >	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< RegistryPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< RegistryPrx >	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< RegistryPrx >	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< RegistryPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< RegistryPrx >	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< RegistryPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< RegistryPrx >	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< RegistryPrx >	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< RegistryPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< RegistryPrx >	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< RegistryPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

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

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

::std::shared_ptr< RegistryPrx >	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< RegistryPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< RegistryPrx >	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< RegistryPrx >	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

The IceGrid registry allows clients create sessions directly with the registry.

See also: Session; AdminSession

Member Function Documentation

◆ createAdminSession()

::std::shared_ptr<AdminSessionPrx> IceGrid::RegistryPrx::createAdminSession	(	const ::std::string &	userId,
		const ::std::string &	password,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Create an administrative session.

Parameters

userId	The user id.
password	The password for the given user id.
context	The Context map to send with the invocation.

Returns: A proxy for the newly created session.

Exceptions

IceGrid::PermissionDeniedException Raised if the password for the given user id is not correct, or if the user is not allowed access.

◆ createAdminSessionAsync() [1/2]

::std::function<void()> IceGrid::RegistryPrx::createAdminSessionAsync	(	const ::std::string &	userId,
		const ::std::string &	password,
		::std::function< void(::std::shared_ptr<::IceGrid::AdminSessionPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Create an administrative session.

Parameters

userId	The user id.
password	The password for the given user id.
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.

◆ createAdminSessionAsync() [2/2]

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

auto IceGrid::RegistryPrx::createAdminSessionAsync	(	const ::std::string &	userId,
		const ::std::string &	password,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::std::shared_ptr<::IceGrid::AdminSessionPrx>>>().get_future())

inline

Create an administrative session.

Parameters

userId	The user id.
password	The password for the given user id.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ createAdminSessionFromSecureConnection()

::std::shared_ptr<AdminSessionPrx> IceGrid::RegistryPrx::createAdminSessionFromSecureConnection ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Create an administrative session from a secure connection.

Parameters

context The Context map to send with the invocation.

Returns: A proxy for the newly created session.

Exceptions

IceGrid::PermissionDeniedException Raised if the password for the given user id is not correct, or if the user is not allowed access.

◆ createAdminSessionFromSecureConnectionAsync() [1/2]

::std::function<void()> IceGrid::RegistryPrx::createAdminSessionFromSecureConnectionAsync	(	::std::function< void(::std::shared_ptr<::IceGrid::AdminSessionPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Create an administrative session from a secure connection.

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.

◆ createAdminSessionFromSecureConnectionAsync() [2/2]

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

auto IceGrid::RegistryPrx::createAdminSessionFromSecureConnectionAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<::std::shared_ptr<::IceGrid::AdminSessionPrx>>>().get_future())

inline

Create an administrative session from a secure connection.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ createSession()

::std::shared_ptr<SessionPrx> IceGrid::RegistryPrx::createSession	(	const ::std::string &	userId,
		const ::std::string &	password,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Create a client session.

Parameters

userId	The user id.
password	The password for the given user id.
context	The Context map to send with the invocation.

Returns: A proxy for the newly created session.

Exceptions

IceGrid::PermissionDeniedException Raised if the password for the given user id is not correct, or if the user is not allowed access.

◆ createSessionAsync() [1/2]

::std::function<void()> IceGrid::RegistryPrx::createSessionAsync	(	const ::std::string &	userId,
		const ::std::string &	password,
		::std::function< void(::std::shared_ptr<::IceGrid::SessionPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Create a client session.

Parameters

userId	The user id.
password	The password for the given user id.
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.

◆ createSessionAsync() [2/2]

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

auto IceGrid::RegistryPrx::createSessionAsync	(	const ::std::string &	userId,
		const ::std::string &	password,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::std::shared_ptr<::IceGrid::SessionPrx>>>().get_future())

inline

Create a client session.

Parameters

userId	The user id.
password	The password for the given user id.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ createSessionFromSecureConnection()

::std::shared_ptr<SessionPrx> IceGrid::RegistryPrx::createSessionFromSecureConnection ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Create a client session from a secure connection.

Parameters

context The Context map to send with the invocation.

Returns: A proxy for the newly created session.

Exceptions

IceGrid::PermissionDeniedException Raised if the password for the given user id is not correct, or if the user is not allowed access.

◆ createSessionFromSecureConnectionAsync() [1/2]

::std::function<void()> IceGrid::RegistryPrx::createSessionFromSecureConnectionAsync	(	::std::function< void(::std::shared_ptr<::IceGrid::SessionPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Create a client session from a secure connection.

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.

◆ createSessionFromSecureConnectionAsync() [2/2]

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

auto IceGrid::RegistryPrx::createSessionFromSecureConnectionAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<::std::shared_ptr<::IceGrid::SessionPrx>>>().get_future())

inline

Create a client session from a secure connection.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ getACMTimeout()

int IceGrid::RegistryPrx::getACMTimeout ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Get the value of the ACM timeout.

Clients supporting ACM connection heartbeats can enable them instead of explicitly sending keep alives requests.

NOTE: This method is only available since Ice 3.6.

Parameters

context The Context map to send with the invocation.

Returns: The timeout (in seconds).

◆ getACMTimeoutAsync() [1/2]

::std::function<void()> IceGrid::RegistryPrx::getACMTimeoutAsync	(	::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 value of the ACM timeout.

Clients supporting ACM connection heartbeats can enable them instead of explicitly sending keep alives requests.

NOTE: This method is only available since Ice 3.6.

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.

◆ getACMTimeoutAsync() [2/2]

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

auto IceGrid::RegistryPrx::getACMTimeoutAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<int>>().get_future())

inline

Get the value of the ACM timeout.

Clients supporting ACM connection heartbeats can enable them instead of explicitly sending keep alives requests.

NOTE: This method is only available since Ice 3.6.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ getSessionTimeout()

int IceGrid::RegistryPrx::getSessionTimeout ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Get the session timeout.

If a client or administrative client doesn't call the session keepAlive method in the time interval defined by this timeout, IceGrid might reap the session.

Parameters

context The Context map to send with the invocation.

Returns: The timeout (in seconds).

See also: Session::keepAlive; AdminSession::keepAlive

◆ getSessionTimeoutAsync() [1/2]

::std::function<void()> IceGrid::RegistryPrx::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.

If a client or administrative client doesn't call the session keepAlive method in the time interval defined by this timeout, IceGrid might reap the 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.

See also: Session::keepAlive; AdminSession::keepAlive

◆ getSessionTimeoutAsync() [2/2]

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

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

inline

Get the session timeout.

If a client or administrative client doesn't call the session keepAlive method in the time interval defined by this timeout, IceGrid might reap the session.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

See also: Session::keepAlive; AdminSession::keepAlive

◆ ice_staticId()

static const ::std::string& IceGrid::RegistryPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ createAdminSession()

◆ createAdminSessionAsync() [1/2]

◆ createAdminSessionAsync() [2/2]

◆ createAdminSessionFromSecureConnection()

◆ createAdminSessionFromSecureConnectionAsync() [1/2]

◆ createAdminSessionFromSecureConnectionAsync() [2/2]

◆ createSession()

◆ createSessionAsync() [1/2]

◆ createSessionAsync() [2/2]

◆ createSessionFromSecureConnection()

◆ createSessionFromSecureConnectionAsync() [1/2]

◆ createSessionFromSecureConnectionAsync() [2/2]

◆ getACMTimeout()

◆ getACMTimeoutAsync() [1/2]

◆ getACMTimeoutAsync() [2/2]

◆ getSessionTimeout()

◆ getSessionTimeoutAsync() [1/2]

◆ getSessionTimeoutAsync() [2/2]

◆ ice_staticId()