Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | List of all members
IceDiscovery::LookupPrx Class Reference

The Lookup interface is used by IceDiscovery clients to look for objects and adapters using UDP multicast. More...

#include <IceDiscovery/IceDiscovery.h>

Inheritance diagram for IceDiscovery::LookupPrx:
Inheritance graph
[legend]
Collaboration diagram for IceDiscovery::LookupPrx:
Collaboration graph
[legend]

Public Member Functions

void findAdapterById (const ::std::string &domainId, const ::std::string &id, const ::std::shared_ptr< LookupReplyPrx > &reply, const ::Ice::Context &context=::Ice::noExplicitContext)
 Request to find an object adapter. More...
 
::std::function< void()> findAdapterByIdAsync (const ::std::string &domainId, const ::std::string &id, 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)
 Request to find an object adapter. More...
 
template<template< typename > class P = ::std::promise>
auto findAdapterByIdAsync (const ::std::string &domainId, const ::std::string &id, const ::std::shared_ptr< LookupReplyPrx > &reply, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Request to find an object adapter. More...
 
void findObjectById (const ::std::string &domainId, const ::Ice::Identity &id, const ::std::shared_ptr< LookupReplyPrx > &reply, const ::Ice::Context &context=::Ice::noExplicitContext)
 Request to find an Ice object. More...
 
::std::function< void()> findObjectByIdAsync (const ::std::string &domainId, const ::Ice::Identity &id, 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)
 Request to find an Ice object. More...
 
template<template< typename > class P = ::std::promise>
auto findObjectByIdAsync (const ::std::string &domainId, const ::Ice::Identity &id, const ::std::shared_ptr< LookupReplyPrx > &reply, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Request to find an Ice object. 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 Lookup interface is used by IceDiscovery clients to look for objects and adapters using UDP multicast.

Member Function Documentation

◆ findAdapterById()

void IceDiscovery::LookupPrx::findAdapterById ( const ::std::string &  domainId,
const ::std::string &  id,
const ::std::shared_ptr< LookupReplyPrx > &  reply,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Request to find an object adapter.

Parameters
domainIdThe IceDiscovery domain identifier. An IceDiscovery client only replies to requests with a matching domain identifier.
idThe adapter ID.
replyThe proxy of the LookupReply interface that should be used to send the reply if a matching adapter is found.
contextThe Context map to send with the invocation.

◆ findAdapterByIdAsync() [1/2]

::std::function<void()> IceDiscovery::LookupPrx::findAdapterByIdAsync ( const ::std::string &  domainId,
const ::std::string &  id,
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

Request to find an object adapter.

Parameters
domainIdThe IceDiscovery domain identifier. An IceDiscovery client only replies to requests with a matching domain identifier.
idThe adapter ID.
replyThe proxy of the LookupReply interface that should be used to send the reply if a matching adapter is found.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe 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 IceDiscovery::LookupPrx::findAdapterByIdAsync ( const ::std::string &  domainId,
const ::std::string &  id,
const ::std::shared_ptr< LookupReplyPrx > &  reply,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Request to find an object adapter.

Parameters
domainIdThe IceDiscovery domain identifier. An IceDiscovery client only replies to requests with a matching domain identifier.
idThe adapter ID.
replyThe proxy of the LookupReply interface that should be used to send the reply if a matching adapter is found.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ findObjectById()

void IceDiscovery::LookupPrx::findObjectById ( const ::std::string &  domainId,
const ::Ice::Identity id,
const ::std::shared_ptr< LookupReplyPrx > &  reply,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Request to find an Ice object.

Parameters
domainIdThe IceDiscovery domain identifier. An IceDiscovery client only replies to requests with a matching domain identifier.
idThe object identity.
replyThe proxy of the LookupReply interface that should be used to send the reply if a matching object is found.
contextThe Context map to send with the invocation.

◆ findObjectByIdAsync() [1/2]

::std::function<void()> IceDiscovery::LookupPrx::findObjectByIdAsync ( const ::std::string &  domainId,
const ::Ice::Identity id,
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

Request to find an Ice object.

Parameters
domainIdThe IceDiscovery domain identifier. An IceDiscovery client only replies to requests with a matching domain identifier.
idThe object identity.
replyThe proxy of the LookupReply interface that should be used to send the reply if a matching object is found.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe 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 IceDiscovery::LookupPrx::findObjectByIdAsync ( const ::std::string &  domainId,
const ::Ice::Identity id,
const ::std::shared_ptr< LookupReplyPrx > &  reply,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Request to find an Ice object.

Parameters
domainIdThe IceDiscovery domain identifier. An IceDiscovery client only replies to requests with a matching domain identifier.
idThe object identity.
replyThe proxy of the LookupReply interface that should be used to send the reply if a matching object is found.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ ice_staticId()

static const ::std::string& IceDiscovery::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: