Represents a session object used by IceGrid clients to allocate and release objects. More...
#include <IceGrid/IceGrid.h>
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. | |
| std::optional< Ice::ObjectPrx > | allocateObjectById (const ::Ice::Identity &id, const Ice::Context &context=Ice::noExplicitContext) const |
| Allocates an object. | |
| std::future< std::optional< Ice::ObjectPrx > > | allocateObjectByIdAsync (const ::Ice::Identity &id, const Ice::Context &context=Ice::noExplicitContext) const |
| Allocates an object. | |
| std::function< void()> | allocateObjectByIdAsync (const ::Ice::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 |
| Allocates an object. | |
| std::optional< Ice::ObjectPrx > | allocateObjectByType (std::string_view type, const Ice::Context &context=Ice::noExplicitContext) const |
| Allocates an object with the given type. | |
| std::future< std::optional< Ice::ObjectPrx > > | allocateObjectByTypeAsync (std::string_view type, const Ice::Context &context=Ice::noExplicitContext) const |
| Allocates an object with the given type. | |
| std::function< void()> | allocateObjectByTypeAsync (std::string_view type, 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 |
| Allocates an object with the given type. | |
| void | keepAlive (const Ice::Context &context=Ice::noExplicitContext) const |
| Keeps the session alive. | |
| std::future< void > | keepAliveAsync (const Ice::Context &context=Ice::noExplicitContext) const |
| Keeps the session alive. | |
| std::function< void()> | keepAliveAsync (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 alive. | |
| SessionPrx & | operator= (const SessionPrx &rhs) noexcept |
| Copy assignment operator. | |
| SessionPrx & | operator= (SessionPrx &&rhs) noexcept |
| Move assignment operator. | |
| void | releaseObject (const ::Ice::Identity &id, const Ice::Context &context=Ice::noExplicitContext) const |
| Releases an object that was allocated using IceGrid::SessionPrx::allocateObjectById or IceGrid::SessionPrx::allocateObjectByType. | |
| std::future< void > | releaseObjectAsync (const ::Ice::Identity &id, const Ice::Context &context=Ice::noExplicitContext) const |
| Releases an object that was allocated using IceGrid::SessionPrx::allocateObjectById or IceGrid::SessionPrx::allocateObjectByType. | |
| std::function< void()> | releaseObjectAsync (const ::Ice::Identity &id, 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 |
| Releases an object that was allocated using IceGrid::SessionPrx::allocateObjectById or IceGrid::SessionPrx::allocateObjectByType. | |
| void | setAllocationTimeout (std::int32_t timeout, const Ice::Context &context=Ice::noExplicitContext) const |
| Sets the allocation timeout. | |
| std::future< void > | setAllocationTimeoutAsync (std::int32_t timeout, const Ice::Context &context=Ice::noExplicitContext) const |
| Sets the allocation timeout. | |
| std::function< void()> | setAllocationTimeoutAsync (std::int32_t timeout, 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 |
| Sets the allocation timeout. | |
| Public Member Functions inherited from Ice::Proxy< SessionPrx, ::Glacier2::SessionPrx > | |
| 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. | |
Represents a session object used by IceGrid clients to allocate and release objects.
Client sessions are created either via the RegistryPrx object or via the registry client Glacier2::SessionManagerPrx object.
1.14.0 