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

The Glacier2 specialization of the Ice::RouterPrx interface. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::RouterPrx:

Public Member Functions

 RouterPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString)
 Constructs a proxy from a Communicator and a proxy string.
 RouterPrx (const RouterPrx &other) noexcept
 Copy constructor.
 RouterPrx (RouterPrx &&other) noexcept
 Move constructor.
std::optional< SessionPrxcreateSession (std::string_view userId, std::string_view password, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a session for the client (caller) with the router.
std::future< std::optional< SessionPrx > > createSessionAsync (std::string_view userId, std::string_view password, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a session for the client (caller) with the router.
std::function< void()> createSessionAsync (std::string_view userId, std::string_view password, std::function< void(std::optional<::Glacier2::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 session for the client (caller) with the router.
std::optional< SessionPrxcreateSessionFromSecureConnection (const Ice::Context &context=Ice::noExplicitContext) const
 Creates a per-client session with the router.
std::future< std::optional< SessionPrx > > createSessionFromSecureConnectionAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Creates a per-client session with the router.
std::function< void()> createSessionFromSecureConnectionAsync (std::function< void(std::optional<::Glacier2::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 per-client session with the router.
void destroySession (const Ice::Context &context=Ice::noExplicitContext) const
 Destroys the session of the caller with this router.
std::future< void > destroySessionAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Destroys the session of the caller with this router.
std::function< void()> destroySessionAsync (std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Destroys the session of the caller with this router.
std::int32_t getACMTimeout (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the idle timeout used by the server-side of the connection.
std::future< std::int32_t > getACMTimeoutAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the idle timeout used by the server-side of the connection.
std::function< void()> getACMTimeoutAsync (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 idle timeout used by the server-side of the connection.
std::string getCategoryForClient (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a unique category that identifies the client (caller) in the router.
std::future< std::string > getCategoryForClientAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a unique category that identifies the client (caller) in the router.
std::function< void()> getCategoryForClientAsync (std::function< void(std::string)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets a unique category that identifies the client (caller) in the router.
std::int64_t getSessionTimeout (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the idle timeout used by the server-side of the connection.
std::future< std::int64_t > getSessionTimeoutAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the idle timeout used by the server-side of the connection.
std::function< void()> getSessionTimeoutAsync (std::function< void(std::int64_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 idle timeout used by the server-side of the connection.
RouterPrxoperator= (const RouterPrx &rhs) noexcept
 Copy assignment operator.
RouterPrxoperator= (RouterPrx &&rhs) noexcept
 Move assignment operator.
void refreshSession (const Ice::Context &context=Ice::noExplicitContext) const
 Keeps the session with this router alive.
std::future< void > refreshSessionAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Keeps the session with this router alive.
std::function< void()> refreshSessionAsync (std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Keeps the session with this router alive.
Public Member Functions inherited from Ice::Proxy< RouterPrx, ::Ice::RouterPrx >
RouterPrx ice_adapterId (std::string id) const
 Creates a proxy that is identical to this proxy, except for the adapter ID.
RouterPrx ice_batchDatagram () const
 Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
RouterPrx ice_batchOneway () const
 Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
RouterPrx ice_collocationOptimized (bool b) const
 Creates a proxy that is identical to this proxy, except for collocation optimization.
RouterPrx 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.
RouterPrx ice_connectionCached (bool b) const
 Creates a proxy that is identical to this proxy, except for connection caching.
RouterPrx ice_connectionId (std::string id) const
 Creates a proxy that is identical to this proxy, except for its connection ID.
RouterPrx ice_context (Context context) const
 Creates a proxy that is identical to this proxy, except for the per-proxy context.
RouterPrx ice_datagram () const
 Creates a proxy that is identical to this proxy, but uses datagram invocations.
RouterPrx ice_encodingVersion (EncodingVersion version) const
 Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
RouterPrx ice_endpoints (EndpointSeq endpoints) const
 Creates a proxy that is identical to this proxy, except for the endpoints.
RouterPrx ice_endpointSelection (EndpointSelectionType type) const
 Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
RouterPrx 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.
RouterPrx ice_invocationTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the invocation timeout.
RouterPrx ice_locator (const std::optional< LocatorPrx > &locator) const
 Creates a proxy that is identical to this proxy, except for the locator.
RouterPrx ice_locatorCacheTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the locator cache timeout.
RouterPrx ice_oneway () const
 Creates a proxy that is identical to this proxy, but uses oneway invocations.
RouterPrx ice_router (const std::optional< RouterPrx > &router) const
 Creates a proxy that is identical to this proxy, except for the router.
RouterPrx ice_twoway () const
 Creates a proxy that is identical to this proxy, but uses twoway invocations.
const RouterPrxoperator-> () 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

The Glacier2 specialization of the Ice::RouterPrx interface.

Definition at line 43 of file Router.h.


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