The Ice lookup interface is implemented by Ice locator implementations and can be used by clients to find available Ice locators on the network. More...

#include <IceLocatorDiscovery/IceLocatorDiscovery.h>

Inheritance diagram for IceLocatorDiscovery::LookupPrx:

[legend]

Collaboration diagram for IceLocatorDiscovery::LookupPrx:

[legend]

Public Member Functions
void	findLocator (const ::std::string &instanceName, const ::std::shared_ptr< LookupReplyPrx > &reply, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find a locator proxy with the given instance name. More...

::std::function< void()>	findLocatorAsync (const ::std::string &instanceName, const ::std::shared_ptr< LookupReplyPrx > &reply, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find a locator proxy with the given instance name. More...

template<template< typename > class P = ::std::promise>
auto	findLocatorAsync (const ::std::string &instanceName, const ::std::shared_ptr< LookupReplyPrx > &reply, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Find a locator proxy with the given instance name. More...

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

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

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

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

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

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

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

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

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

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

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

::std::shared_ptr< LookupPrx >	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< LookupPrx >	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 lookup interface is implemented by Ice locator implementations and can be used by clients to find available Ice locators on the network.

Ice locator implementations provide a well-known `Ice/LocatorLookup' object accessible through UDP multicast. Clients typically make a multicast findLocator request to find the locator proxy.

See also: LookupReply

Member Function Documentation

◆ findLocator()

void IceLocatorDiscovery::LookupPrx::findLocator	(	const ::std::string &	instanceName,
		const ::std::shared_ptr< LookupReplyPrx > &	reply,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Find a locator proxy with the given instance name.

Parameters

instanceName	Restrict the search to Ice registries configured with the given instance name. If empty, all the available registries will reply.
reply	The reply object to use to send the reply.
context	The Context map to send with the invocation.

◆ findLocatorAsync() [1/2]

::std::function<void()> IceLocatorDiscovery::LookupPrx::findLocatorAsync	(	const ::std::string &	instanceName,
		const ::std::shared_ptr< LookupReplyPrx > &	reply,
		::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

Find a locator proxy with the given instance name.

Parameters

instanceName	Restrict the search to Ice registries configured with the given instance name. If empty, all the available registries will reply.
reply	The reply object to use to send the reply.
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.

◆ findLocatorAsync() [2/2]

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

auto IceLocatorDiscovery::LookupPrx::findLocatorAsync	(	const ::std::string &	instanceName,
		const ::std::shared_ptr< LookupReplyPrx > &	reply,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<void>>().get_future())

inline

Find a locator proxy with the given instance name.

Parameters

instanceName	Restrict the search to Ice registries configured with the given instance name. If empty, all the available registries will reply.
reply	The reply object to use to send the reply.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ ice_staticId()

static const ::std::string& IceLocatorDiscovery::LookupPrx::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/IceLocatorDiscovery/IceLocatorDiscovery.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ findLocator()

◆ findLocatorAsync() [1/2]

◆ findLocatorAsync() [2/2]

◆ ice_staticId()