The Ice locator registry interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::LocatorRegistryPrx:

Collaboration diagram for Ice::LocatorRegistryPrx:

Public Member Functions
void	setAdapterDirectProxy (const ::std::string &id, const ::std::shared_ptr< ObjectPrx > &proxy, const Context &context=noExplicitContext)
	Set the adapter endpoints with the locator registry. More...

::std::function< void()>	setAdapterDirectProxyAsync (const ::std::string &id, const ::std::shared_ptr< ObjectPrx > &proxy, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Set the adapter endpoints with the locator registry. More...

template<template< typename > class P = ::std::promise>
auto	setAdapterDirectProxyAsync (const ::std::string &id, const ::std::shared_ptr< ObjectPrx > &proxy, const Context &context=noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Set the adapter endpoints with the locator registry. More...

void	setReplicatedAdapterDirectProxy (const ::std::string &adapterId, const ::std::string &replicaGroupId, const ::std::shared_ptr< ObjectPrx > &p, const Context &context=noExplicitContext)
	Set the adapter endpoints with the locator registry. More...

::std::function< void()>	setReplicatedAdapterDirectProxyAsync (const ::std::string &adapterId, const ::std::string &replicaGroupId, const ::std::shared_ptr< ObjectPrx > &p, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Set the adapter endpoints with the locator registry. More...

template<template< typename > class P = ::std::promise>
auto	setReplicatedAdapterDirectProxyAsync (const ::std::string &adapterId, const ::std::string &replicaGroupId, const ::std::shared_ptr< ObjectPrx > &p, const Context &context=noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Set the adapter endpoints with the locator registry. More...

void	setServerProcessProxy (const ::std::string &id, const ::std::shared_ptr< ProcessPrx > &proxy, const Context &context=noExplicitContext)
	Set the process proxy for a server. More...

::std::function< void()>	setServerProcessProxyAsync (const ::std::string &id, const ::std::shared_ptr< ProcessPrx > &proxy, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Set the process proxy for a server. More...

template<template< typename > class P = ::std::promise>
auto	setServerProcessProxyAsync (const ::std::string &id, const ::std::shared_ptr< ProcessPrx > &proxy, const Context &context=noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Set the process proxy for a server. More...

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

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

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

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

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

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

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

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

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

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

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

::std::shared_ptr< LocatorRegistryPrx >	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< LocatorRegistryPrx >	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 Ice locator registry interface.

This interface is used by servers to register adapter endpoints with the locator.

The LocatorRegistry interface is intended to be used by Ice internals and by locator implementations. Regular user code should not attempt to use any functionality of this interface directly.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& Ice::LocatorRegistryPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

◆ setAdapterDirectProxy()

void Ice::LocatorRegistryPrx::setAdapterDirectProxy	(	const ::std::string &	id,
		const ::std::shared_ptr< ObjectPrx > &	proxy,
		const Context &	context = `noExplicitContext`
	)

inline

Set the adapter endpoints with the locator registry.

Parameters

id	The adapter id.
proxy	The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
context	The Context map to send with the invocation.

Exceptions

Ice::AdapterAlreadyActiveException	Raised if an adapter with the same id is already active.
Ice::AdapterNotFoundException	Raised if the adapter cannot be found, or if the locator only allows registered adapters to set their active proxy and the adapter is not registered with the locator.

◆ setAdapterDirectProxyAsync() [1/2]

::std::function<void()> Ice::LocatorRegistryPrx::setAdapterDirectProxyAsync	(	const ::std::string &	id,
		const ::std::shared_ptr< ObjectPrx > &	proxy,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

Set the adapter endpoints with the locator registry.

Parameters

id	The adapter id.
proxy	The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
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.

◆ setAdapterDirectProxyAsync() [2/2]

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

auto Ice::LocatorRegistryPrx::setAdapterDirectProxyAsync	(	const ::std::string &	id,
		const ::std::shared_ptr< ObjectPrx > &	proxy,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<void>>().get_future())

inline

Set the adapter endpoints with the locator registry.

Parameters

id	The adapter id.
proxy	The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ setReplicatedAdapterDirectProxy()

void Ice::LocatorRegistryPrx::setReplicatedAdapterDirectProxy	(	const ::std::string &	adapterId,
		const ::std::string &	replicaGroupId,
		const ::std::shared_ptr< ObjectPrx > &	p,
		const Context &	context = `noExplicitContext`
	)

inline

Set the adapter endpoints with the locator registry.

Parameters

adapterId	The adapter id.
replicaGroupId	The replica group id.
p	The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
context	The Context map to send with the invocation.

Exceptions

Ice::AdapterAlreadyActiveException	Raised if an adapter with the same id is already active.
Ice::AdapterNotFoundException	Raised if the adapter cannot be found, or if the locator only allows registered adapters to set their active proxy and the adapter is not registered with the locator.
Ice::InvalidReplicaGroupIdException	Raised if the given replica group doesn't match the one registered with the locator registry for this object adapter.

◆ setReplicatedAdapterDirectProxyAsync() [1/2]

::std::function<void()> Ice::LocatorRegistryPrx::setReplicatedAdapterDirectProxyAsync	(	const ::std::string &	adapterId,
		const ::std::string &	replicaGroupId,
		const ::std::shared_ptr< ObjectPrx > &	p,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

Set the adapter endpoints with the locator registry.

Parameters

adapterId	The adapter id.
replicaGroupId	The replica group id.
p	The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
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.

◆ setReplicatedAdapterDirectProxyAsync() [2/2]

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

auto Ice::LocatorRegistryPrx::setReplicatedAdapterDirectProxyAsync	(	const ::std::string &	adapterId,
		const ::std::string &	replicaGroupId,
		const ::std::shared_ptr< ObjectPrx > &	p,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<void>>().get_future())

inline

Set the adapter endpoints with the locator registry.

Parameters

adapterId	The adapter id.
replicaGroupId	The replica group id.
p	The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ setServerProcessProxy()

void Ice::LocatorRegistryPrx::setServerProcessProxy	(	const ::std::string &	id,
		const ::std::shared_ptr< ProcessPrx > &	proxy,
		const Context &	context = `noExplicitContext`
	)

inline

Set the process proxy for a server.

Parameters

id	The server id.
proxy	The process proxy.
context	The Context map to send with the invocation.

Exceptions

Ice::ServerNotFoundException Raised if the server cannot be found.

◆ setServerProcessProxyAsync() [1/2]

::std::function<void()> Ice::LocatorRegistryPrx::setServerProcessProxyAsync	(	const ::std::string &	id,
		const ::std::shared_ptr< ProcessPrx > &	proxy,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

Set the process proxy for a server.

Parameters

id	The server id.
proxy	The process proxy.
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.

◆ setServerProcessProxyAsync() [2/2]

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

auto Ice::LocatorRegistryPrx::setServerProcessProxyAsync	(	const ::std::string &	id,
		const ::std::shared_ptr< ProcessPrx > &	proxy,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<void>>().get_future())

inline

Set the process proxy for a server.

Parameters

id	The server id.
proxy	The process proxy.
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/Ice/Locator.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ice_staticId()

◆ setAdapterDirectProxy()

◆ setAdapterDirectProxyAsync() [1/2]

◆ setAdapterDirectProxyAsync() [2/2]

◆ setReplicatedAdapterDirectProxy()

◆ setReplicatedAdapterDirectProxyAsync() [1/2]

◆ setReplicatedAdapterDirectProxyAsync() [2/2]

◆ setServerProcessProxy()

◆ setServerProcessProxyAsync() [1/2]

◆ setServerProcessProxyAsync() [2/2]