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

This inferface should be implemented by services implementing the Ice::Router interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::RouterFinderPrx:
Inheritance graph
[legend]
Collaboration diagram for Ice::RouterFinderPrx:
Collaboration graph
[legend]

Public Member Functions

::std::shared_ptr< RouterPrxgetRouter (const Context &context=noExplicitContext)
 Get the router proxy implemented by the process hosting this finder object. More...
 
::std::function< void()> getRouterAsync (::std::function< void(::std::shared_ptr<::Ice::RouterPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
 Get the router proxy implemented by the process hosting this finder object. More...
 
template<template< typename > class P = ::std::promise>
auto getRouterAsync (const Context &context=noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::RouterPrx >>>().get_future())
 Get the router proxy implemented by the process hosting this finder object. More...
 
- Public Member Functions inherited from Ice::Proxy< RouterFinderPrx, ObjectPrx >
::std::shared_ptr< RouterFinderPrxice_adapterId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for the adapter ID. More...
 
::std::shared_ptr< RouterFinderPrxice_batchDatagram () const
 Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...
 
::std::shared_ptr< RouterFinderPrxice_batchOneway () const
 Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...
 
::std::shared_ptr< RouterFinderPrxice_collocationOptimized (bool b) const
 Obtains a proxy that is identical to this proxy, except for collocation optimization. More...
 
::std::shared_ptr< RouterFinderPrxice_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< RouterFinderPrxice_connectionCached (bool b) const
 Obtains a proxy that is identical to this proxy, except for connection caching. More...
 
::std::shared_ptr< RouterFinderPrxice_connectionId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for its connection ID. More...
 
::std::shared_ptr< RouterFinderPrxice_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< RouterFinderPrxice_datagram () const
 Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...
 
::std::shared_ptr< RouterFinderPrxice_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< RouterFinderPrxice_endpoints (const ::Ice::EndpointSeq &endpoints) const
 Obtains a proxy that is identical to this proxy, except for the endpoints. More...
 
::std::shared_ptr< RouterFinderPrxice_endpointSelection (::Ice::EndpointSelectionType type) const
 Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...
 
::std::shared_ptr< RouterFinderPrxice_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< RouterFinderPrxice_invocationTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...
 
::std::shared_ptr< RouterFinderPrxice_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< RouterFinderPrxice_locatorCacheTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...
 
::std::shared_ptr< RouterFinderPrxice_oneway () const
 Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...
 
::std::shared_ptr< RouterFinderPrxice_preferSecure (bool b) const
 Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...
 
::std::shared_ptr< RouterFinderPrxice_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< RouterFinderPrxice_secure (bool b) const
 Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...
 
::std::shared_ptr< RouterFinderPrxice_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< RouterFinderPrxice_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

This inferface should be implemented by services implementing the Ice::Router interface.

It should be advertised through an Ice object with the identity `Ice/RouterFinder'. This allows clients to retrieve the router proxy with just the endpoint information of the service.

Member Function Documentation

◆ getRouter()

::std::shared_ptr<RouterPrx> Ice::RouterFinderPrx::getRouter ( const Context context = noExplicitContext)
inline

Get the router proxy implemented by the process hosting this finder object.

The proxy might point to several replicas.

Parameters
contextThe Context map to send with the invocation.
Returns
The router proxy.

◆ getRouterAsync() [1/2]

::std::function<void()> Ice::RouterFinderPrx::getRouterAsync ( ::std::function< void(::std::shared_ptr<::Ice::RouterPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const Context context = noExplicitContext 
)
inline

Get the router proxy implemented by the process hosting this finder object.

The proxy might point to several replicas.

Parameters
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.

◆ getRouterAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto Ice::RouterFinderPrx::getRouterAsync ( const Context context = noExplicitContext) -> decltype(::std::declval<P<::std::shared_ptr<::Ice::RouterPrx>>>().get_future())
inline

Get the router proxy implemented by the process hosting this finder object.

The proxy might point to several replicas.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ ice_staticId()

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