Ice 3.8
C++ API Reference
Loading...
Searching...
No Matches
Ice::LocatorPrx Class Reference

Client applications use the Locator object to resolve Ice indirect proxies. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::LocatorPrx:

Public Member Functions

 LocatorPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString)
 Constructs a proxy from a Communicator and a proxy string.
 LocatorPrx (const LocatorPrx &other) noexcept
 Copy constructor.
 LocatorPrx (LocatorPrx &&other) noexcept
 Move constructor.
std::optional< Ice::ObjectPrxfindAdapterById (std::string_view id, const Ice::Context &context=Ice::noExplicitContext) const
 Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).
std::future< std::optional< Ice::ObjectPrx > > findAdapterByIdAsync (std::string_view id, const Ice::Context &context=Ice::noExplicitContext) const
 Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).
std::function< void()> findAdapterByIdAsync (std::string_view id, std::function< void(std::optional< Ice::ObjectPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).
std::optional< Ice::ObjectPrxfindObjectById (const Identity &id, const Ice::Context &context=Ice::noExplicitContext) const
 Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object.
std::future< std::optional< Ice::ObjectPrx > > findObjectByIdAsync (const Identity &id, const Ice::Context &context=Ice::noExplicitContext) const
 Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object.
std::function< void()> findObjectByIdAsync (const Identity &id, std::function< void(std::optional< Ice::ObjectPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object.
std::optional< LocatorRegistryPrxgetRegistry (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to the locator registry.
std::future< std::optional< LocatorRegistryPrx > > getRegistryAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to the locator registry.
std::function< void()> getRegistryAsync (std::function< void(std::optional<::Ice::LocatorRegistryPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to the locator registry.
LocatorPrxoperator= (const LocatorPrx &rhs) noexcept
 Copy assignment operator.
LocatorPrxoperator= (LocatorPrx &&rhs) noexcept
 Move assignment operator.
Public Member Functions inherited from Ice::Proxy< LocatorPrx, Ice::ObjectPrx >
LocatorPrx ice_adapterId (std::string id) const
 Creates a proxy that is identical to this proxy, except for the adapter ID.
LocatorPrx ice_batchDatagram () const
 Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
LocatorPrx ice_batchOneway () const
 Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
LocatorPrx ice_collocationOptimized (bool b) const
 Creates a proxy that is identical to this proxy, except for collocation optimization.
LocatorPrx ice_compress (bool b) const
 Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
LocatorPrx ice_connectionCached (bool b) const
 Creates a proxy that is identical to this proxy, except for connection caching.
LocatorPrx ice_connectionId (std::string id) const
 Creates a proxy that is identical to this proxy, except for its connection ID.
LocatorPrx ice_context (Context context) const
 Creates a proxy that is identical to this proxy, except for the per-proxy context.
LocatorPrx ice_datagram () const
 Creates a proxy that is identical to this proxy, but uses datagram invocations.
LocatorPrx ice_encodingVersion (EncodingVersion version) const
 Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
LocatorPrx ice_endpoints (EndpointSeq endpoints) const
 Creates a proxy that is identical to this proxy, except for the endpoints.
LocatorPrx ice_endpointSelection (EndpointSelectionType type) const
 Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
LocatorPrx ice_fixed (ConnectionPtr connection) const
 Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
LocatorPrx ice_invocationTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the invocation timeout.
LocatorPrx ice_locator (const std::optional< LocatorPrx > &locator) const
 Creates a proxy that is identical to this proxy, except for the locator.
LocatorPrx ice_locatorCacheTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the locator cache timeout.
LocatorPrx ice_oneway () const
 Creates a proxy that is identical to this proxy, but uses oneway invocations.
LocatorPrx ice_router (const std::optional< RouterPrx > &router) const
 Creates a proxy that is identical to this proxy, except for the router.
LocatorPrx ice_twoway () const
 Creates a proxy that is identical to this proxy, but uses twoway invocations.
const LocatorPrxoperator-> () const noexcept
 The arrow operator.

Static Public Member Functions

static const char * ice_staticId () noexcept
 Gets the type ID of the associated Slice interface.

Detailed Description

Client applications use the Locator object to resolve Ice indirect proxies.

This object also allows server applications to retrieve a proxy to the associated LocatorRegistryPrx object where they can register their object adapters.

Definition at line 37 of file Locator.h.


The documentation for this class was generated from the following file: