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

The IceGrid locator interface provides access to the Query and Registry object of the IceGrid registry. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::LocatorPrx:
Inheritance graph
[legend]
Collaboration diagram for IceGrid::LocatorPrx:
Collaboration graph
[legend]

Public Member Functions

::std::shared_ptr< QueryPrxgetLocalQuery (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the proxy of the query object hosted by this IceGrid registry. More...
 
::std::function< void()> getLocalQueryAsync (::std::function< void(::std::shared_ptr<::IceGrid::QueryPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the proxy of the query object hosted by this IceGrid registry. More...
 
template<template< typename > class P = ::std::promise>
auto getLocalQueryAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::IceGrid::QueryPrx >>>().get_future())
 Get the proxy of the query object hosted by this IceGrid registry. More...
 
::std::shared_ptr< RegistryPrxgetLocalRegistry (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the proxy of the registry object hosted by this IceGrid registry. More...
 
::std::function< void()> getLocalRegistryAsync (::std::function< void(::std::shared_ptr<::IceGrid::RegistryPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the proxy of the registry object hosted by this IceGrid registry. More...
 
template<template< typename > class P = ::std::promise>
auto getLocalRegistryAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::IceGrid::RegistryPrx >>>().get_future())
 Get the proxy of the registry object hosted by this IceGrid registry. More...
 
- Public Member Functions inherited from Ice::Proxy< LocatorPrx, ::Ice::LocatorPrx >
::std::shared_ptr< LocatorPrxice_adapterId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for the adapter ID. More...
 
::std::shared_ptr< LocatorPrxice_batchDatagram () const
 Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...
 
::std::shared_ptr< LocatorPrxice_batchOneway () const
 Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...
 
::std::shared_ptr< LocatorPrxice_collocationOptimized (bool b) const
 Obtains a proxy that is identical to this proxy, except for collocation optimization. More...
 
::std::shared_ptr< LocatorPrxice_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< LocatorPrxice_connectionCached (bool b) const
 Obtains a proxy that is identical to this proxy, except for connection caching. More...
 
::std::shared_ptr< LocatorPrxice_connectionId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for its connection ID. More...
 
::std::shared_ptr< LocatorPrxice_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< LocatorPrxice_datagram () const
 Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...
 
::std::shared_ptr< LocatorPrxice_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< LocatorPrxice_endpoints (const ::Ice::EndpointSeq &endpoints) const
 Obtains a proxy that is identical to this proxy, except for the endpoints. More...
 
::std::shared_ptr< LocatorPrxice_endpointSelection (::Ice::EndpointSelectionType type) const
 Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...
 
::std::shared_ptr< LocatorPrxice_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< LocatorPrxice_invocationTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...
 
::std::shared_ptr< LocatorPrxice_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< LocatorPrxice_locatorCacheTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...
 
::std::shared_ptr< LocatorPrxice_oneway () const
 Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...
 
::std::shared_ptr< LocatorPrxice_preferSecure (bool b) const
 Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...
 
::std::shared_ptr< LocatorPrxice_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< LocatorPrxice_secure (bool b) const
 Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...
 
::std::shared_ptr< LocatorPrxice_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< LocatorPrxice_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 IceGrid locator interface provides access to the Query and Registry object of the IceGrid registry.

See also
Query
Registry

Member Function Documentation

◆ getLocalQuery()

::std::shared_ptr<QueryPrx> IceGrid::LocatorPrx::getLocalQuery ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get the proxy of the query object hosted by this IceGrid registry.

Parameters
contextThe Context map to send with the invocation.
Returns
The proxy of the query object.

◆ getLocalQueryAsync() [1/2]

::std::function<void()> IceGrid::LocatorPrx::getLocalQueryAsync ( ::std::function< void(::std::shared_ptr<::IceGrid::QueryPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the proxy of the query object hosted by this IceGrid registry.

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.

◆ getLocalQueryAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::LocatorPrx::getLocalQueryAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::std::shared_ptr<::IceGrid::QueryPrx>>>().get_future())
inline

Get the proxy of the query object hosted by this IceGrid registry.

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

◆ getLocalRegistry()

::std::shared_ptr<RegistryPrx> IceGrid::LocatorPrx::getLocalRegistry ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get the proxy of the registry object hosted by this IceGrid registry.

Parameters
contextThe Context map to send with the invocation.
Returns
The proxy of the registry object.

◆ getLocalRegistryAsync() [1/2]

::std::function<void()> IceGrid::LocatorPrx::getLocalRegistryAsync ( ::std::function< void(::std::shared_ptr<::IceGrid::RegistryPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the proxy of the registry object hosted by this IceGrid registry.

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.

◆ getLocalRegistryAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::LocatorPrx::getLocalRegistryAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::std::shared_ptr<::IceGrid::RegistryPrx>>>().get_future())
inline

Get the proxy of the registry object hosted by this IceGrid registry.

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

◆ ice_staticId()

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