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

The base class for all Ice proxies. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::ObjectPrx:

Public Member Functions

 ObjectPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString)
 Constructs a proxy from a Communicator and a proxy string.
 ObjectPrx (const ObjectPrx &other) noexcept=default
 Copy constructor.
 ObjectPrx (ObjectPrx &&other) noexcept=default
 Move constructor.
template<typename Prx = ObjectPrx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
Prx ice_facet (std::string facet) const
 Creates a proxy that is identical to this proxy, except for the facet.
void ice_flushBatchRequests () const
 Flushes any pending batched requests for this communicator. The call blocks until the flush is complete.
std::future< void > ice_flushBatchRequestsAsync () const
 Flushes asynchronously any pending batched requests for this communicator.
std::function< void()> ice_flushBatchRequestsAsync (std::function< void(std::exception_ptr)> ex, std::function< void(bool)> sent=nullptr) const
 Flushes asynchronously any pending batched requests for this communicator.
std::string ice_getAdapterId () const
 Gets the adapter ID for this proxy.
Ice::ConnectionPtr ice_getCachedConnection () const noexcept
 Gets the cached Connection for this proxy.
Ice::CommunicatorPtr ice_getCommunicator () const noexcept
 Gets the communicator that created this proxy.
std::optional< bool > ice_getCompress () const noexcept
 Gets the compression override setting of this proxy.
Ice::ConnectionPtr ice_getConnection () const
 Gets the connection for this proxy.
std::future< Ice::ConnectionPtrice_getConnectionAsync () const
 Gets the connection for this proxy.
std::function< void()> ice_getConnectionAsync (std::function< void(Ice::ConnectionPtr)> response, std::function< void(std::exception_ptr)> ex=nullptr, std::function< void(bool)> sent=nullptr) const
 Gets the connection for this proxy.
std::string ice_getConnectionId () const
 Gets the connection ID of this proxy.
Ice::Context ice_getContext () const
 Gets the per-proxy context for this proxy.
Ice::EncodingVersion ice_getEncodingVersion () const noexcept
 Gets the encoding version used to marshal request parameters.
Ice::EndpointSeq ice_getEndpoints () const
 Gets the endpoints used by this proxy.
Ice::EndpointSelectionType ice_getEndpointSelection () const noexcept
 Gets the endpoint selection policy for this proxy (randomly or ordered).
const std::string & ice_getFacet () const noexcept
 Gets the facet for this proxy.
const Ice::Identityice_getIdentity () const noexcept
 Gets the identity embedded in this proxy.
std::chrono::milliseconds ice_getInvocationTimeout () const noexcept
 Gets the invocation timeout of this proxy.
std::optional< LocatorPrxice_getLocator () const noexcept
 Gets the locator for this proxy.
std::chrono::milliseconds ice_getLocatorCacheTimeout () const noexcept
 Gets the locator cache timeout of this proxy.
std::optional< RouterPrxice_getRouter () const noexcept
 Gets the router for this proxy.
std::string ice_id (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the type ID of the most-derived Slice interface supported by this object.
std::future< std::string > ice_idAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the type ID of the most-derived Slice interface supported by this object.
std::function< void()> ice_idAsync (std::function< void(std::string)> response, std::function< void(std::exception_ptr)> ex=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the type ID of the most-derived Slice interface supported by this object.
template<typename Prx = ObjectPrx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
Prx ice_identity (Ice::Identity id) const
 Creates a proxy that is identical to this proxy, except for the identity.
std::vector< std::string > ice_ids (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the Slice interfaces supported by this object as a list of type IDs.
std::future< std::vector< std::string > > ice_idsAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the Slice interfaces supported by this object as a list of type IDs.
std::function< void()> ice_idsAsync (std::function< void(std::vector< std::string >)> response, std::function< void(std::exception_ptr)> ex=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the Slice interfaces supported by this object as a list of type IDs.
bool ice_invoke (std::string_view operation, Ice::OperationMode mode, const std::vector< std::byte > &inParams, std::vector< std::byte > &outParams, const Ice::Context &context=Ice::noExplicitContext) const
 Invokes an operation.
bool ice_invoke (std::string_view operation, Ice::OperationMode mode, std::pair< const std::byte *, const std::byte * > inParams, std::vector< std::byte > &outParams, const Ice::Context &context=Ice::noExplicitContext) const
 Invokes an operation.
std::future< std::tuple< bool, std::vector< std::byte > > > ice_invokeAsync (std::string_view operation, Ice::OperationMode mode, const std::vector< std::byte > &inParams, const Ice::Context &context=Ice::noExplicitContext) const
 Invokes an operation asynchronously.
std::function< void()> ice_invokeAsync (std::string_view operation, Ice::OperationMode mode, const std::vector< std::byte > &inParams, std::function< void(bool, std::vector< std::byte >)> response, std::function< void(std::exception_ptr)> ex=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Invokes an operation asynchronously.
std::future< std::tuple< bool, std::vector< std::byte > > > ice_invokeAsync (std::string_view operation, Ice::OperationMode mode, std::pair< const std::byte *, const std::byte * > inParams, const Ice::Context &context=Ice::noExplicitContext) const
 Invokes an operation asynchronously.
std::function< void()> ice_invokeAsync (std::string_view operation, Ice::OperationMode mode, std::pair< const std::byte *, const std::byte * > inParams, std::function< void(bool, std::pair< const std::byte *, const std::byte * >)> response, std::function< void(std::exception_ptr)> ex=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Invokes an operation asynchronously.
bool ice_isA (std::string_view typeId, const Ice::Context &context=Ice::noExplicitContext) const
 Tests whether this object supports a specific Slice interface.
std::future< bool > ice_isAAsync (std::string_view typeId, const Ice::Context &context=Ice::noExplicitContext) const
 Tests whether this object supports a specific Slice interface.
std::function< void()> ice_isAAsync (std::string_view typeId, std::function< void(bool)> response, std::function< void(std::exception_ptr)> ex=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Tests whether this object supports a specific Slice interface.
bool ice_isBatchDatagram () const noexcept
 Determines whether this proxy uses batch datagram invocations.
bool ice_isBatchOneway () const noexcept
 Determines whether this proxy uses batch oneway invocations.
bool ice_isCollocationOptimized () const noexcept
 Determines whether this proxy uses collocation optimization.
bool ice_isConnectionCached () const noexcept
 Determines whether this proxy caches connections.
bool ice_isDatagram () const noexcept
 Determines whether this proxy uses datagram invocations.
bool ice_isFixed () const noexcept
 Determines whether this proxy is a fixed proxy.
bool ice_isOneway () const noexcept
 Determines whether this proxy uses oneway invocations.
bool ice_isTwoway () const noexcept
 Determines whether this proxy uses twoway invocations.
void ice_ping (const Ice::Context &context=Ice::noExplicitContext) const
 Tests whether the target object of this proxy can be reached.
std::future< void > ice_pingAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Tests whether the target object of this proxy can be reached.
std::function< void()> ice_pingAsync (std::function< void()> response, std::function< void(std::exception_ptr)> ex=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Tests whether the target object of this proxy can be reached.
std::string ice_toString () const
 Creates a stringified version of this proxy.
ObjectPrxoperator= (const ObjectPrx &rhs) noexcept=default
 Copy assignment operator.
ObjectPrxoperator= (ObjectPrx &&rhs) noexcept=default
 Move assignment operator.
Public Member Functions inherited from Ice::Proxy< ObjectPrx >
ObjectPrx ice_adapterId (std::string id) const
 Creates a proxy that is identical to this proxy, except for the adapter ID.
ObjectPrx ice_batchDatagram () const
 Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
ObjectPrx ice_batchOneway () const
 Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
ObjectPrx ice_collocationOptimized (bool b) const
 Creates a proxy that is identical to this proxy, except for collocation optimization.
ObjectPrx 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.
ObjectPrx ice_connectionCached (bool b) const
 Creates a proxy that is identical to this proxy, except for connection caching.
ObjectPrx ice_connectionId (std::string id) const
 Creates a proxy that is identical to this proxy, except for its connection ID.
ObjectPrx ice_context (Context context) const
 Creates a proxy that is identical to this proxy, except for the per-proxy context.
ObjectPrx ice_datagram () const
 Creates a proxy that is identical to this proxy, but uses datagram invocations.
ObjectPrx ice_encodingVersion (EncodingVersion version) const
 Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
ObjectPrx ice_endpoints (EndpointSeq endpoints) const
 Creates a proxy that is identical to this proxy, except for the endpoints.
ObjectPrx ice_endpointSelection (EndpointSelectionType type) const
 Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
ObjectPrx 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.
ObjectPrx ice_invocationTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the invocation timeout.
ObjectPrx ice_locator (const std::optional< LocatorPrx > &locator) const
 Creates a proxy that is identical to this proxy, except for the locator.
ObjectPrx ice_locatorCacheTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the locator cache timeout.
ObjectPrx ice_oneway () const
 Creates a proxy that is identical to this proxy, but uses oneway invocations.
ObjectPrx ice_router (const std::optional< RouterPrx > &router) const
 Creates a proxy that is identical to this proxy, except for the router.
ObjectPrx ice_twoway () const
 Creates a proxy that is identical to this proxy, but uses twoway invocations.
const ObjectPrxoperator-> () const noexcept
 The arrow operator.

Static Public Member Functions

static const char * ice_staticId () noexcept
 Returns the Slice type ID associated with this type.

Friends

template<typename Prx, typename... Bases>
class Proxy

Detailed Description

The base class for all Ice proxies.

Definition at line 231 of file Proxy.h.


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