The Ice locator interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::LocatorPrx:

Collaboration diagram for Ice::LocatorPrx:

Public Member Functions
::std::shared_ptr< ObjectPrx >	findAdapterById (const ::std::string &id, const Context &context=noExplicitContext)
	Find an adapter by id and return a proxy that contains its endpoints. More...

::std::function< void()>	findAdapterByIdAsync (const ::std::string &id, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Find an adapter by id and return a proxy that contains its endpoints. More...

template<template< typename > class P = ::std::promise>
auto	findAdapterByIdAsync (const ::std::string &id, const Context &context=noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
	Find an adapter by id and return a proxy that contains its endpoints. More...

::std::shared_ptr< ObjectPrx >	findObjectById (const Identity &id, const Context &context=noExplicitContext)
	Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object. More...

::std::function< void()>	findObjectByIdAsync (const Identity &id, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object. More...

template<template< typename > class P = ::std::promise>
auto	findObjectByIdAsync (const Identity &id, const Context &context=noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
	Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object. More...

::std::shared_ptr< LocatorRegistryPrx >	getRegistry (const Context &context=noExplicitContext)
	Get the locator registry. More...

::std::function< void()>	getRegistryAsync (::std::function< void(::std::shared_ptr<::Ice::LocatorRegistryPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Get the locator registry. More...

template<template< typename > class P = ::std::promise>
auto	getRegistryAsync (const Context &context=noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::LocatorRegistryPrx >>>().get_future())
	Get the locator registry. More...

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

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

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

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

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

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

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

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

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

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

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

::std::shared_ptr< LocatorPrx >	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< LocatorPrx >	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 interface.

This interface is used by clients to lookup adapters and objects. It is also used by servers to get the locator registry proxy.

The Locator 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

◆ findAdapterById()

::std::shared_ptr<ObjectPrx> Ice::LocatorPrx::findAdapterById	(	const ::std::string &	id,
		const Context &	context = `noExplicitContext`
	)

inline

Find an adapter by id and return a proxy that contains its endpoints.

Parameters

id	The adapter id.
context	The Context map to send with the invocation.

Returns: The adapter proxy, or null if the adapter is not active.

Exceptions

Ice::AdapterNotFoundException Raised if the adapter cannot be found.

◆ findAdapterByIdAsync() [1/2]

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

inline

Find an adapter by id and return a proxy that contains its endpoints.

Parameters

id	The adapter 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.

◆ findAdapterByIdAsync() [2/2]

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

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

inline

Find an adapter by id and return a proxy that contains its endpoints.

Parameters

id	The adapter id.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ findObjectById()

::std::shared_ptr<ObjectPrx> Ice::LocatorPrx::findObjectById	(	const Identity &	id,
		const Context &	context = `noExplicitContext`
	)

inline

Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object.

Parameters

id	The identity.
context	The Context map to send with the invocation.

Returns: The proxy, or null if the object is not active.

Exceptions

Ice::ObjectNotFoundException Raised if the object cannot be found.

◆ findObjectByIdAsync() [1/2]

::std::function<void()> Ice::LocatorPrx::findObjectByIdAsync	(	const Identity &	id,
		::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object.

Parameters

id	The identity.
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.

◆ findObjectByIdAsync() [2/2]

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

auto Ice::LocatorPrx::findObjectByIdAsync	(	const Identity &	id,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())

inline

Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object.

Parameters

id	The identity.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ getRegistry()

::std::shared_ptr<LocatorRegistryPrx> Ice::LocatorPrx::getRegistry ( const Context & context = noExplicitContext )

inline

Get the locator registry.

Parameters

context The Context map to send with the invocation.

Returns: The locator registry.

◆ getRegistryAsync() [1/2]

::std::function<void()> Ice::LocatorPrx::getRegistryAsync	(	::std::function< void(::std::shared_ptr<::Ice::LocatorRegistryPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

Get the locator registry.

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.

◆ getRegistryAsync() [2/2]

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

auto Ice::LocatorPrx::getRegistryAsync ( const Context & context = noExplicitContext ) -> decltype(::std::declval<P<::std::shared_ptr<::Ice::LocatorRegistryPrx>>>().get_future())

inline

Get the locator registry.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ ice_staticId()

static const ::std::string& Ice::LocatorPrx::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/Ice/Locator.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ findAdapterById()

◆ findAdapterByIdAsync() [1/2]

◆ findAdapterByIdAsync() [2/2]

◆ findObjectById()

◆ findObjectByIdAsync() [1/2]

◆ findObjectByIdAsync() [2/2]

◆ getRegistry()

◆ getRegistryAsync() [1/2]

◆ getRegistryAsync() [2/2]

◆ ice_staticId()