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

Represents the main entry point into the IceGrid registry service. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::RegistryPrx:

Public Member Functions

 RegistryPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString)
 Constructs a proxy from a Communicator and a proxy string.
 RegistryPrx (const RegistryPrx &other) noexcept
 Copy constructor.
 RegistryPrx (RegistryPrx &&other) noexcept
 Move constructor.
std::optional< AdminSessionPrxcreateAdminSession (std::string_view userId, std::string_view password, const Ice::Context &context=Ice::noExplicitContext) const
 Creates an administrative session.
std::future< std::optional< AdminSessionPrx > > createAdminSessionAsync (std::string_view userId, std::string_view password, const Ice::Context &context=Ice::noExplicitContext) const
 Creates an administrative session.
std::function< void()> createAdminSessionAsync (std::string_view userId, std::string_view password, std::function< void(std::optional<::IceGrid::AdminSessionPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Creates an administrative session.
std::optional< AdminSessionPrxcreateAdminSessionFromSecureConnection (const Ice::Context &context=Ice::noExplicitContext) const
 Creates an administrative session from a secure connection.
std::future< std::optional< AdminSessionPrx > > createAdminSessionFromSecureConnectionAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Creates an administrative session from a secure connection.
std::function< void()> createAdminSessionFromSecureConnectionAsync (std::function< void(std::optional<::IceGrid::AdminSessionPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Creates an administrative session from a secure connection.
std::optional< SessionPrxcreateSession (std::string_view userId, std::string_view password, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a client session.
std::future< std::optional< SessionPrx > > createSessionAsync (std::string_view userId, std::string_view password, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a client session.
std::function< void()> createSessionAsync (std::string_view userId, std::string_view password, std::function< void(std::optional<::IceGrid::SessionPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a client session.
std::optional< SessionPrxcreateSessionFromSecureConnection (const Ice::Context &context=Ice::noExplicitContext) const
 Creates a client session from a secure connection.
std::future< std::optional< SessionPrx > > createSessionFromSecureConnectionAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Creates a client session from a secure connection.
std::function< void()> createSessionFromSecureConnectionAsync (std::function< void(std::optional<::IceGrid::SessionPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a client session from a secure connection.
std::int32_t getSessionTimeout (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the session timeout.
std::future< std::int32_t > getSessionTimeoutAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the session timeout.
std::function< void()> getSessionTimeoutAsync (std::function< void(std::int32_t)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the session timeout.
RegistryPrxoperator= (const RegistryPrx &rhs) noexcept
 Copy assignment operator.
RegistryPrxoperator= (RegistryPrx &&rhs) noexcept
 Move assignment operator.
Public Member Functions inherited from Ice::Proxy< RegistryPrx, Ice::ObjectPrx >
RegistryPrx ice_adapterId (std::string id) const
 Creates a proxy that is identical to this proxy, except for the adapter ID.
RegistryPrx ice_batchDatagram () const
 Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
RegistryPrx ice_batchOneway () const
 Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
RegistryPrx ice_collocationOptimized (bool b) const
 Creates a proxy that is identical to this proxy, except for collocation optimization.
RegistryPrx 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.
RegistryPrx ice_connectionCached (bool b) const
 Creates a proxy that is identical to this proxy, except for connection caching.
RegistryPrx ice_connectionId (std::string id) const
 Creates a proxy that is identical to this proxy, except for its connection ID.
RegistryPrx ice_context (Context context) const
 Creates a proxy that is identical to this proxy, except for the per-proxy context.
RegistryPrx ice_datagram () const
 Creates a proxy that is identical to this proxy, but uses datagram invocations.
RegistryPrx ice_encodingVersion (EncodingVersion version) const
 Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
RegistryPrx ice_endpoints (EndpointSeq endpoints) const
 Creates a proxy that is identical to this proxy, except for the endpoints.
RegistryPrx ice_endpointSelection (EndpointSelectionType type) const
 Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
RegistryPrx 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.
RegistryPrx ice_invocationTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the invocation timeout.
RegistryPrx ice_locator (const std::optional< LocatorPrx > &locator) const
 Creates a proxy that is identical to this proxy, except for the locator.
RegistryPrx ice_locatorCacheTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the locator cache timeout.
RegistryPrx ice_oneway () const
 Creates a proxy that is identical to this proxy, but uses oneway invocations.
RegistryPrx ice_router (const std::optional< RouterPrx > &router) const
 Creates a proxy that is identical to this proxy, except for the router.
RegistryPrx ice_twoway () const
 Creates a proxy that is identical to this proxy, but uses twoway invocations.
const RegistryPrx * operator-> () 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

Represents the main entry point into the IceGrid registry service.

It provides operations to create sessions with the registry.

Definition at line 274 of file Registry.h.


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