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

Provides access to a LocatorPrx object via a fixed identity. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::LocatorFinderPrx:

Public Member Functions

 LocatorFinderPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString)
 Constructs a proxy from a Communicator and a proxy string.
 LocatorFinderPrx (const LocatorFinderPrx &other) noexcept
 Copy constructor.
 LocatorFinderPrx (LocatorFinderPrx &&other) noexcept
 Move constructor.
std::optional< LocatorPrxgetLocator (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to the associated Ice::LocatorPrx.
std::future< std::optional< LocatorPrx > > getLocatorAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to the associated Ice::LocatorPrx.
std::function< void()> getLocatorAsync (std::function< void(std::optional<::Ice::LocatorPrx >)> 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 associated Ice::LocatorPrx.
LocatorFinderPrxoperator= (const LocatorFinderPrx &rhs) noexcept
 Copy assignment operator.
LocatorFinderPrxoperator= (LocatorFinderPrx &&rhs) noexcept
 Move assignment operator.
Public Member Functions inherited from Ice::Proxy< LocatorFinderPrx, Ice::ObjectPrx >
LocatorFinderPrx ice_adapterId (std::string id) const
 Creates a proxy that is identical to this proxy, except for the adapter ID.
LocatorFinderPrx ice_batchDatagram () const
 Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
LocatorFinderPrx ice_batchOneway () const
 Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
LocatorFinderPrx ice_collocationOptimized (bool b) const
 Creates a proxy that is identical to this proxy, except for collocation optimization.
LocatorFinderPrx 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.
LocatorFinderPrx ice_connectionCached (bool b) const
 Creates a proxy that is identical to this proxy, except for connection caching.
LocatorFinderPrx ice_connectionId (std::string id) const
 Creates a proxy that is identical to this proxy, except for its connection ID.
LocatorFinderPrx ice_context (Context context) const
 Creates a proxy that is identical to this proxy, except for the per-proxy context.
LocatorFinderPrx ice_datagram () const
 Creates a proxy that is identical to this proxy, but uses datagram invocations.
LocatorFinderPrx ice_encodingVersion (EncodingVersion version) const
 Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
LocatorFinderPrx ice_endpoints (EndpointSeq endpoints) const
 Creates a proxy that is identical to this proxy, except for the endpoints.
LocatorFinderPrx ice_endpointSelection (EndpointSelectionType type) const
 Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
LocatorFinderPrx 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.
LocatorFinderPrx ice_invocationTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the invocation timeout.
LocatorFinderPrx ice_locator (const std::optional< LocatorPrx > &locator) const
 Creates a proxy that is identical to this proxy, except for the locator.
LocatorFinderPrx ice_locatorCacheTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the locator cache timeout.
LocatorFinderPrx ice_oneway () const
 Creates a proxy that is identical to this proxy, but uses oneway invocations.
LocatorFinderPrx ice_router (const std::optional< RouterPrx > &router) const
 Creates a proxy that is identical to this proxy, except for the router.
LocatorFinderPrx ice_twoway () const
 Creates a proxy that is identical to this proxy, but uses twoway invocations.
const LocatorFinderPrxoperator-> () 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

Provides access to a LocatorPrx object via a fixed identity.

A LocatorFinder is always registered with identity Ice/LocatorFinder. This allows clients to obtain the associated Locator proxy with just the endpoint information of the object. For example, you can use the LocatorFinder proxy Ice/LocatorFinder:tcp -h somehost -p 4061 to get the Locator proxy MyIceGrid/Locator:tcp -h somehost -p 4061.

Definition at line 189 of file Locator.h.


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