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

Represents a session between a client application and the Glacier2 router. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::SessionPrx:

Public Member Functions

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

With Glacier2, the lifetime of a session is tied to the Ice connection between the client and the router: the session is destroyed when the connection is closed.

See also
Router
SessionManager

Definition at line 58 of file Session.h.


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