Base class of all object proxies. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::ObjectPrx:

Collaboration diagram for Ice::ObjectPrx:

Public Member Functions
::std::shared_ptr<::Ice::ObjectPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_compress (bool b) const
	Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_facet (const ::std::string &facet) const
	Obtains a proxy that is identical to this proxy, except for the facet. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...

void	ice_flushBatchRequests ()
	Flushes any pending batched requests for this communicator. More...

template<template< typename > class P = std::promise>
auto	ice_flushBatchRequestsAsync () -> decltype(std::declval< P< void >>().get_future())
	Flushes asynchronously any pending batched requests for this communicator. More...

std::function< void()>	ice_flushBatchRequestsAsync (::std::function< void(::std::exception_ptr)> ex, ::std::function< void(bool)> sent=nullptr)
	Flushes asynchronously any pending batched requests for this communicator. More...

::std::string	ice_getAdapterId () const
	Obtains the adapter ID for this proxy. More...

::std::shared_ptr<::Ice::Connection >	ice_getCachedConnection () const
	Obtains the cached Connection for this proxy. More...

::std::shared_ptr<::Ice::Communicator >	ice_getCommunicator () const
	Obtains the communicator that created this proxy. More...

::Ice::optional< bool >	ice_getCompress () const
	Obtains the compression override setting of this proxy. More...

::std::shared_ptr<::Ice::Connection >	ice_getConnection ()
	Obtains the Connection for this proxy. More...

template<template< typename > class P = std::promise>
auto	ice_getConnectionAsync () -> decltype(std::declval< P<::std::shared_ptr<::Ice::Connection >>>().get_future())
	Obtains the Connection for this proxy. More...

::std::function< void()>	ice_getConnectionAsync (::std::function< void(::std::shared_ptr<::Ice::Connection >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr)
	Obtains the Connection for this proxy. More...

::std::string	ice_getConnectionId () const
	Obtains the connection ID of this proxy. More...

::Ice::Context	ice_getContext () const
	Obtains the per-proxy context for this proxy. More...

::Ice::EncodingVersion	ice_getEncodingVersion () const
	Obtains the encoding version used to marshal request parameters. More...

::Ice::EndpointSeq	ice_getEndpoints () const
	Obtains the endpoints used by this proxy. More...

::Ice::EndpointSelectionType	ice_getEndpointSelection () const
	Obtains the endpoint selection policy for this proxy (randomly or ordered). More...

const ::std::string &	ice_getFacet () const
	Obtains the facet for this proxy. More...

::Ice::Identity	ice_getIdentity () const
	Obtains the identity embedded in this proxy. More...

::Ice::Int	ice_getInvocationTimeout () const
	Obtains the invocation timeout of this proxy. More...

::std::shared_ptr<::Ice::LocatorPrx >	ice_getLocator () const
	Obtains the locator for this proxy. More...

::Ice::Int	ice_getLocatorCacheTimeout () const
	Obtains the locator cache timeout of this proxy. More...

::std::shared_ptr<::Ice::RouterPrx >	ice_getRouter () const
	Obtains the router for this proxy. More...

::Ice::optional< int >	ice_getTimeout () const
	Obtains the timeout override of this proxy. More...

::std::string	ice_id (const ::Ice::Context &context=::Ice::noExplicitContext)
	Returns the Slice type ID of the most-derived interface supported by the target object of this proxy. More...

::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)
	Returns the Slice type ID of the most-derived interface supported by the target object of this proxy. More...

template<template< typename > class P = std::promise>
auto	ice_idAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(std::declval< P<::std::string >>().get_future())
	Returns the Slice type ID of the most-derived interface supported by the target object of this proxy. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_identity (const ::Ice::Identity &id) const
	Obtains a proxy that is identical to this proxy, except for the identity. More...

::std::vector<::std::string >	ice_ids (const ::Ice::Context &context=::Ice::noExplicitContext)
	Returns the Slice type IDs of the interfaces supported by the target object of this proxy. More...

::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)
	Returns the Slice type IDs of the interfaces supported by the target object of this proxy. More...

template<template< typename > class P = std::promise>
auto	ice_idsAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(std::declval< P<::std::vector<::std::string >>>().get_future())
	Returns the Slice type IDs of the interfaces supported by the target object of this proxy. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_invocationTimeout (::Ice::Int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

bool	ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams, ::std::vector<::Ice::Byte > &outParams, const ::Ice::Context &context=::Ice::noExplicitContext)
	Invokes an operation dynamically. More...

bool	ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< Byte > &inParams, ::std::vector<::Ice::Byte > &outParams, const ::Ice::Context &context=::Ice::noExplicitContext)
	Invokes an operation dynamically. More...

::std::function< void()>	ice_invokeAsync (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams, ::std::function< void(bool, ::std::pair< const ::Ice::Byte , const ::Ice::Byte >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Invokes an operation dynamically. More...

template<template< typename > class P = std::promise>
auto	ice_invokeAsync (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(std::declval< P<::Ice::Object::Ice_invokeResult >>().get_future())
	Invokes an operation dynamically. More...

template<template< typename > class P = std::promise>
auto	ice_invokeAsync (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< Byte > &inParams, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(std::declval< P<::Ice::Object::Ice_invokeResult >>().get_future())
	Invokes an operation dynamically. More...

::std::function< void()>	ice_invokeAsync (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector<::Ice::Byte > &inParams, ::std::function< void(bool, ::std::vector<::Ice::Byte >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Invokes an operation dynamically. More...

bool	ice_isA (const ::std::string &typeId, const ::Ice::Context &context=::Ice::noExplicitContext)
	Tests whether this object supports a specific Slice interface. More...

::std::function< void()>	ice_isAAsync (const ::std::string &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)
	Tests whether this object supports a specific Slice interface. More...

template<template< typename > class P = std::promise>
auto	ice_isAAsync (const ::std::string &typeId, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(std::declval< P< bool >>().get_future())
	Tests whether this object supports a specific Slice interface. More...

bool	ice_isBatchDatagram () const
	Determines whether this proxy uses batch datagram invocations. More...

bool	ice_isBatchOneway () const
	Determines whether this proxy uses batch oneway invocations. More...

bool	ice_isCollocationOptimized () const
	Determines whether this proxy uses collocation optimization. More...

bool	ice_isConnectionCached () const
	Determines whether this proxy caches connections. More...

bool	ice_isDatagram () const
	Determines whether this proxy uses datagram invocations. More...

bool	ice_isFixed () const
	Determines whether this proxy is a fixed proxy. More...

bool	ice_isOneway () const
	Determines whether this proxy uses oneway invocations. More...

bool	ice_isPreferSecure () const
	Determines whether this proxy prefers secure endpoints. More...

bool	ice_isSecure () const
	Determines whether this proxy uses only secure endpoints. More...

bool	ice_isTwoway () const
	Determines whether this proxy uses twoway invocations. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_locatorCacheTimeout (::Ice::Int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...

void	ice_ping (const ::Ice::Context &context=::Ice::noExplicitContext)
	Tests whether the target object of this proxy can be reached. More...

::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)
	Tests whether the target object of this proxy can be reached. More...

template<template< typename > class P = std::promise>
auto	ice_pingAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(std::declval< P< void >>().get_future())
	Tests whether the target object of this proxy can be reached. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_timeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...

::std::string	ice_toString () const
	Obtains a stringified version of this proxy. More...

::std::shared_ptr<::Ice::ObjectPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

virtual	~ObjectPrx ()=default

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Returns the Slice type ID associated with this type. More...

Friends
bool	operator< (const ObjectPrx &, const ObjectPrx &)

bool	operator== (const ObjectPrx &, const ObjectPrx &)

Detailed Description

Base class of all object proxies.

Constructor & Destructor Documentation

◆ ~ObjectPrx()

virtual Ice::ObjectPrx::~ObjectPrx ( )

virtualdefault

Member Function Documentation

◆ ice_adapterId()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_adapterId ( const ::std::string & id ) const

Obtains a proxy that is identical to this proxy, except for the adapter ID.

Parameters

id	The adapter ID for the new proxy.

Returns: A proxy with the new adapter ID.

◆ ice_batchDatagram()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_batchDatagram ( ) const

Obtains a proxy that is identical to this proxy, but uses batch datagram invocations.

Returns: A proxy that uses batch datagram invocations.

◆ ice_batchOneway()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_batchOneway ( ) const

Obtains a proxy that is identical to this proxy, but uses batch oneway invocations.

Returns: A proxy that uses batch oneway invocations.

◆ ice_collocationOptimized()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_collocationOptimized ( bool b ) const

Obtains a proxy that is identical to this proxy, except for collocation optimization.

Parameters

b	True if the new proxy enables collocation optimization, false otherwise.

Returns: A proxy with the specified collocation optimization.

◆ ice_compress()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_compress ( bool b ) const

Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.

Parameters

b	True enables compression for the new proxy, false disables compression.

Returns: A proxy with the specified compression override setting.

◆ ice_connectionCached()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_connectionCached ( bool b ) const

Obtains a proxy that is identical to this proxy, except for connection caching.

Parameters

b	True if the new proxy should cache connections, false otherwise.

Returns: A proxy with the specified caching policy.

◆ ice_connectionId()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_connectionId ( const ::std::string & id ) const

Obtains a proxy that is identical to this proxy, except for its connection ID.

Parameters

id	The connection ID for the new proxy. An empty string removes the connection ID.

Returns: A proxy with the specified connection ID.

◆ ice_context()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_context ( const ::Ice::Context & context ) const

Obtains a proxy that is identical to this proxy, except for the per-proxy context.

Parameters

context The context for the new proxy.

Returns: A proxy with the new per-proxy context.

◆ ice_datagram()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_datagram ( ) const

Obtains a proxy that is identical to this proxy, but uses datagram invocations.

Returns: A proxy that uses datagram invocations.

◆ ice_encodingVersion()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_encodingVersion ( const ::Ice::EncodingVersion & version ) const

Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters.

Parameters

version The encoding version to use to marshal request parameters.

Returns: A proxy with the specified encoding version.

◆ ice_endpoints()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_endpoints ( const ::Ice::EndpointSeq & endpoints ) const

Obtains a proxy that is identical to this proxy, except for the endpoints.

Parameters

endpoints The endpoints for the new proxy.

Returns: A proxy with the new endpoints.

◆ ice_endpointSelection()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_endpointSelection ( ::Ice::EndpointSelectionType type ) const

Obtains a proxy that is identical to this proxy, except for the endpoint selection policy.

Parameters

type	The new endpoint selection policy.

Returns: A proxy with the specified endpoint selection policy.

◆ ice_facet()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_facet ( const ::std::string & facet ) const

Obtains a proxy that is identical to this proxy, except for the facet.

Parameters

facet The facet for the new proxy.

Returns: A proxy with the new facet.

◆ ice_fixed()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_fixed ( const ::std::shared_ptr<::Ice::Connection > & connection ) const

Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.

Parameters

connection The fixed proxy connection.

Returns: A fixed proxy bound to the given connection.

◆ ice_flushBatchRequests()

void Ice::ObjectPrx::ice_flushBatchRequests ( )

inline

Flushes any pending batched requests for this communicator.

The call blocks until the flush is complete.

◆ ice_flushBatchRequestsAsync() [1/2]

template<template< typename > class P = std::promise>

auto Ice::ObjectPrx::ice_flushBatchRequestsAsync ( ) -> decltype(std::declval<P<void>>().get_future())

inline

Flushes asynchronously any pending batched requests for this communicator.

Returns: The future object for the invocation.

◆ ice_flushBatchRequestsAsync() [2/2]

std::function<void()> Ice::ObjectPrx::ice_flushBatchRequestsAsync	(	::std::function< void(::std::exception_ptr)>	ex,
		::std::function< void(bool)>	sent = `nullptr`
	)

inline

Flushes asynchronously any pending batched requests for this communicator.

Parameters

ex	The exception callback.
sent	The sent callback.

Returns: A function that can be called to cancel the invocation locally.

◆ ice_getAdapterId()

::std::string Ice::ObjectPrx::ice_getAdapterId ( ) const

Obtains the adapter ID for this proxy.

Returns: The adapter ID. If the proxy does not have an adapter ID, the return value is the empty string.

◆ ice_getCachedConnection()

::std::shared_ptr<::Ice::Connection> Ice::ObjectPrx::ice_getCachedConnection ( ) const

Obtains the cached Connection for this proxy.

If the proxy does not yet have an established connection, it does not attempt to create a connection.

Returns: The cached connection for this proxy, or nil if the proxy does not have an established connection.

◆ ice_getCommunicator()

::std::shared_ptr<::Ice::Communicator> Ice::ObjectPrx::ice_getCommunicator ( ) const

Obtains the communicator that created this proxy.

Returns: The communicator that created this proxy.

◆ ice_getCompress()

::Ice::optional<bool> Ice::ObjectPrx::ice_getCompress ( ) const

Obtains the compression override setting of this proxy.

Returns: The compression override setting. If nullopt is returned, no override is set. Otherwise, true if compression is enabled, false otherwise.

◆ ice_getConnection()

::std::shared_ptr<::Ice::Connection> Ice::ObjectPrx::ice_getConnection ( )

inline

Obtains the Connection for this proxy.

If the proxy does not yet have an established connection, it first attempts to create a connection.

Returns: The connection for this proxy.

◆ ice_getConnectionAsync() [1/2]

template<template< typename > class P = std::promise>

auto Ice::ObjectPrx::ice_getConnectionAsync ( ) -> decltype(std::declval<P<::std::shared_ptr<::Ice::Connection>>>().get_future())

inline

Obtains the Connection for this proxy.

If the proxy does not yet have an established connection, it first attempts to create a connection.

Returns: The future object for the invocation.

◆ ice_getConnectionAsync() [2/2]

::std::function<void()> Ice::ObjectPrx::ice_getConnectionAsync	(	::std::function< void(::std::shared_ptr<::Ice::Connection >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`
	)

inline

Obtains the Connection for this proxy.

If the proxy does not yet have an established connection, it first attempts to create a connection.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.

Returns: A function that can be called to cancel the invocation locally.

◆ ice_getConnectionId()

::std::string Ice::ObjectPrx::ice_getConnectionId ( ) const

Obtains the connection ID of this proxy.

Returns: The connection ID.

◆ ice_getContext()

::Ice::Context Ice::ObjectPrx::ice_getContext ( ) const

Obtains the per-proxy context for this proxy.

Returns: The per-proxy context.

◆ ice_getEncodingVersion()

::Ice::EncodingVersion Ice::ObjectPrx::ice_getEncodingVersion ( ) const

Obtains the encoding version used to marshal request parameters.

Returns: The encoding version.

◆ ice_getEndpoints()

::Ice::EndpointSeq Ice::ObjectPrx::ice_getEndpoints ( ) const

Obtains the endpoints used by this proxy.

Returns: The endpoints used by this proxy.

◆ ice_getEndpointSelection()

::Ice::EndpointSelectionType Ice::ObjectPrx::ice_getEndpointSelection ( ) const

Obtains the endpoint selection policy for this proxy (randomly or ordered).

Returns: The endpoint selection policy.

◆ ice_getFacet()

const ::std::string& Ice::ObjectPrx::ice_getFacet ( ) const

Obtains the facet for this proxy.

Returns: The facet for this proxy. If the proxy uses the default facet, the return value is the empty string.

◆ ice_getIdentity()

::Ice::Identity Ice::ObjectPrx::ice_getIdentity ( ) const

Obtains the identity embedded in this proxy.

Returns: The identity of the target object.

◆ ice_getInvocationTimeout()

::Ice::Int Ice::ObjectPrx::ice_getInvocationTimeout ( ) const

Obtains the invocation timeout of this proxy.

Returns: The invocation timeout value (in milliseconds).

◆ ice_getLocator()

::std::shared_ptr<::Ice::LocatorPrx> Ice::ObjectPrx::ice_getLocator ( ) const

Obtains the locator for this proxy.

Returns: The locator for this proxy. If no locator is configured, the return value is nil.

◆ ice_getLocatorCacheTimeout()

::Ice::Int Ice::ObjectPrx::ice_getLocatorCacheTimeout ( ) const

Obtains the locator cache timeout of this proxy.

Returns: The locator cache timeout value (in seconds).

◆ ice_getRouter()

::std::shared_ptr<::Ice::RouterPrx> Ice::ObjectPrx::ice_getRouter ( ) const

Obtains the router for this proxy.

Returns: The router for the proxy. If no router is configured for the proxy, the return value is nil.

◆ ice_getTimeout()

::Ice::optional<int> Ice::ObjectPrx::ice_getTimeout ( ) const

Obtains the timeout override of this proxy.

Returns: The timeout override. If nullopt is returned, no override is set. Otherwise, returns the timeout override value.

◆ ice_id()

::std::string Ice::ObjectPrx::ice_id ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.

Parameters

context The context map for the invocation.

Returns: The Slice type ID of the most-derived interface.

◆ ice_idAsync() [1/2]

::std::function<void()> Ice::ObjectPrx::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`
	)

inline

Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The context map for the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ ice_idAsync() [2/2]

template<template< typename > class P = std::promise>

auto Ice::ObjectPrx::ice_idAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(std::declval<P<::std::string>>().get_future())

inline

Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.

Parameters

context The context map for the invocation.

Returns: The future object for the invocation.

◆ ice_identity()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_identity ( const ::Ice::Identity & id ) const

Obtains a proxy that is identical to this proxy, except for the identity.

Parameters

id	The identity for the new proxy.

Returns: A proxy with the new identity.

◆ ice_ids()

::std::vector<::std::string> Ice::ObjectPrx::ice_ids ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Returns the Slice type IDs of the interfaces supported by the target object of this proxy.

Parameters

context The context map for the invocation.

Returns: The Slice type IDs of the interfaces supported by the target object, in base-to-derived order. The first element of the returned array is always "::Ice::Object".

◆ ice_idsAsync() [1/2]

::std::function<void()> Ice::ObjectPrx::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`
	)

inline

Returns the Slice type IDs of the interfaces supported by the target object of this proxy.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The context map for the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ ice_idsAsync() [2/2]

template<template< typename > class P = std::promise>

auto Ice::ObjectPrx::ice_idsAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(std::declval<P<::std::vector<::std::string>>>().get_future())

inline

Returns the Slice type IDs of the interfaces supported by the target object of this proxy.

Parameters

context The context map for the invocation.

Returns: The future object for the invocation.

◆ ice_invocationTimeout()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_invocationTimeout ( ::Ice::Int timeout ) const

Obtains a proxy that is identical to this proxy, except for the invocation timeout.

Parameters

timeout The new invocation timeout (in milliseconds).

Returns: A proxy with the new timeout.

◆ ice_invoke() [1/2]

bool Ice::ObjectPrx::ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams,
		::std::vector<::Ice::Byte > &	outParams,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Invokes an operation dynamically.

Parameters

operation	The name of the operation to invoke.
mode	The operation mode (normal or idempotent).
inParams	An encapsulation containing the encoded in-parameters for the operation.
outParams	An encapsulation containing the encoded results.
context	The context map for the invocation.

Returns: True if the operation completed successfully, in which case outParams contains the encoded out parameters. False if the operation raised a user exception, in which case outParams contains the encoded user exception. If the operation raises a run-time exception, it throws it directly.

◆ ice_invoke() [2/2]

bool Ice::ObjectPrx::ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< Byte > &	inParams,
		::std::vector<::Ice::Byte > &	outParams,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Invokes an operation dynamically.

Parameters

operation	The name of the operation to invoke.
mode	The operation mode (normal or idempotent).
inParams	An encapsulation containing the encoded in-parameters for the operation.
outParams	An encapsulation containing the encoded results.
context	The context map for the invocation.

Returns: True if the operation completed successfully, in which case outParams contains the encoded out parameters. False if the operation raised a user exception, in which case outParams contains the encoded user exception. If the operation raises a run-time exception, it throws it directly.

◆ ice_invokeAsync() [1/4]

::std::function<void()> Ice::ObjectPrx::ice_invokeAsync	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams,
		::std::function< void(bool, ::std::pair< const ::Ice::Byte , const ::Ice::Byte >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Invokes an operation dynamically.

Parameters

operation	The name of the operation to invoke.
mode	The operation mode (normal or idempotent).
inParams	An encapsulation containing the encoded in-parameters for the operation.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The context map for the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ ice_invokeAsync() [2/4]

template<template< typename > class P = std::promise>

auto Ice::ObjectPrx::ice_invokeAsync	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(std::declval<P<::Ice::Object::Ice_invokeResult>>().get_future())

inline

Invokes an operation dynamically.

Parameters

operation	The name of the operation to invoke.
mode	The operation mode (normal or idempotent).
inParams	An encapsulation containing the encoded in-parameters for the operation.
context	The context map for the invocation.

Returns: The future object for the invocation.

◆ ice_invokeAsync() [3/4]

template<template< typename > class P = std::promise>

auto Ice::ObjectPrx::ice_invokeAsync	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< Byte > &	inParams,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(std::declval<P<::Ice::Object::Ice_invokeResult>>().get_future())

inline

Invokes an operation dynamically.

Parameters

operation	The name of the operation to invoke.
mode	The operation mode (normal or idempotent).
inParams	An encapsulation containing the encoded in-parameters for the operation.
context	The context map for the invocation.

Returns: The future object for the invocation.

◆ ice_invokeAsync() [4/4]

::std::function<void()> Ice::ObjectPrx::ice_invokeAsync	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector<::Ice::Byte > &	inParams,
		::std::function< void(bool, ::std::vector<::Ice::Byte >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Invokes an operation dynamically.

Parameters

operation	The name of the operation to invoke.
mode	The operation mode (normal or idempotent).
inParams	An encapsulation containing the encoded in-parameters for the operation.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The context map for the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ ice_isA()

bool Ice::ObjectPrx::ice_isA	(	const ::std::string &	typeId,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Tests whether this object supports a specific Slice interface.

Parameters

typeId	The type ID of the Slice interface to test against.
context	The context map for the invocation.

Returns: true if the target object has the interface specified by id or derives from the interface specified by id.

◆ ice_isAAsync() [1/2]

::std::function<void()> Ice::ObjectPrx::ice_isAAsync	(	const ::std::string &	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`
	)

inline

Tests whether this object supports a specific Slice interface.

Parameters

typeId	The type ID of the Slice interface to test against.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The context map for the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ ice_isAAsync() [2/2]

template<template< typename > class P = std::promise>

auto Ice::ObjectPrx::ice_isAAsync	(	const ::std::string &	typeId,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(std::declval<P<bool>>().get_future())

inline

Tests whether this object supports a specific Slice interface.

Parameters

typeId	The type ID of the Slice interface to test against.
context	The context map for the invocation.

Returns: The future object for the invocation.

◆ ice_isBatchDatagram()

bool Ice::ObjectPrx::ice_isBatchDatagram ( ) const

Determines whether this proxy uses batch datagram invocations.

Returns: True if this proxy uses batch datagram invocations, false otherwise.

◆ ice_isBatchOneway()

bool Ice::ObjectPrx::ice_isBatchOneway ( ) const

Determines whether this proxy uses batch oneway invocations.

Returns: True if this proxy uses batch oneway invocations, false otherwise.

◆ ice_isCollocationOptimized()

bool Ice::ObjectPrx::ice_isCollocationOptimized ( ) const

Determines whether this proxy uses collocation optimization.

Returns: True if the proxy uses collocation optimization, false otherwise.

◆ ice_isConnectionCached()

bool Ice::ObjectPrx::ice_isConnectionCached ( ) const

Determines whether this proxy caches connections.

Returns: True if this proxy caches connections, false otherwise.

◆ ice_isDatagram()

bool Ice::ObjectPrx::ice_isDatagram ( ) const

Determines whether this proxy uses datagram invocations.

Returns: True if this proxy uses datagram invocations, false otherwise.

◆ ice_isFixed()

bool Ice::ObjectPrx::ice_isFixed ( ) const

Determines whether this proxy is a fixed proxy.

Returns: True if this proxy is a fixed proxy, false otherwise.

◆ ice_isOneway()

bool Ice::ObjectPrx::ice_isOneway ( ) const

Determines whether this proxy uses oneway invocations.

Returns: True if this proxy uses oneway invocations, false otherwise.

◆ ice_isPreferSecure()

bool Ice::ObjectPrx::ice_isPreferSecure ( ) const

Determines whether this proxy prefers secure endpoints.

Returns: True if the proxy always attempts to invoke via secure endpoints before it attempts to use insecure endpoints, false otherwise.

◆ ice_isSecure()

bool Ice::ObjectPrx::ice_isSecure ( ) const

Determines whether this proxy uses only secure endpoints.

Returns: True if this proxy communicates only via secure endpoints, false otherwise.

◆ ice_isTwoway()

bool Ice::ObjectPrx::ice_isTwoway ( ) const

Determines whether this proxy uses twoway invocations.

Returns: True if this proxy uses twoway invocations, false otherwise.

◆ ice_locator()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_locator ( const ::std::shared_ptr<::Ice::LocatorPrx > & locator ) const

Obtains a proxy that is identical to this proxy, except for the locator.

Parameters

locator The locator for the new proxy.

Returns: A proxy with the specified locator.

◆ ice_locatorCacheTimeout()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_locatorCacheTimeout ( ::Ice::Int timeout ) const

Obtains a proxy that is identical to this proxy, except for the locator cache timeout.

Parameters

timeout The new locator cache timeout (in seconds).

Returns: A proxy with the new timeout.

◆ ice_oneway()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_oneway ( ) const

Obtains a proxy that is identical to this proxy, but uses oneway invocations.

Returns: A proxy that uses oneway invocations.

◆ ice_ping()

void Ice::ObjectPrx::ice_ping ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Tests whether the target object of this proxy can be reached.

Parameters

context The context map for the invocation.

◆ ice_pingAsync() [1/2]

::std::function<void()> Ice::ObjectPrx::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`
	)

inline

Tests whether the target object of this proxy can be reached.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The context map for the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ ice_pingAsync() [2/2]

template<template< typename > class P = std::promise>

auto Ice::ObjectPrx::ice_pingAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(std::declval<P<void>>().get_future())

inline

Tests whether the target object of this proxy can be reached.

Parameters

context The context map for the invocation.

Returns: The future object for the invocation.

◆ ice_preferSecure()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_preferSecure ( bool b ) const

Obtains a proxy that is identical to this proxy, except for its endpoint selection policy.

Parameters

b	If true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If false, the proxy prefers insecure endpoints to secure ones.

Returns: A proxy with the specified selection policy.

◆ ice_router()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_router ( const ::std::shared_ptr<::Ice::RouterPrx > & router ) const

Obtains a proxy that is identical to this proxy, except for the router.

Parameters

router The router for the new proxy.

Returns: A proxy with the specified router.

◆ ice_secure()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_secure ( bool b ) const

Obtains a proxy that is identical to this proxy, except for how it selects endpoints.

Parameters

b	If true, only endpoints that use a secure transport are used by the new proxy. If false, the returned proxy uses both secure and insecure endpoints.

Returns: A proxy with the specified security policy.

◆ ice_staticId()

static const ::std::string& Ice::ObjectPrx::ice_staticId ( )

inlinestatic

Returns the Slice type ID associated with this type.

Returns: The Slice type ID.

◆ ice_timeout()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_timeout ( int timeout ) const

Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints.

Parameters

timeout The connection timeout override for the proxy (in milliseconds).

Returns: A proxy with the specified timeout override.

◆ ice_toString()

::std::string Ice::ObjectPrx::ice_toString ( ) const

Obtains a stringified version of this proxy.

Returns: A stringified proxy.

◆ ice_twoway()

::std::shared_ptr<::Ice::ObjectPrx> Ice::ObjectPrx::ice_twoway ( ) const

Obtains a proxy that is identical to this proxy, but uses twoway invocations.

Returns: A proxy that uses twoway invocations.

Friends And Related Function Documentation

◆ operator<

bool operator<	(	const ObjectPrx &	,
		const ObjectPrx &
	)

friend

◆ operator==

bool operator==	(	const ObjectPrx &	,
		const ObjectPrx &
	)

friend

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

Ice/Proxy.h

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~ObjectPrx()

Member Function Documentation

◆ ice_adapterId()

◆ ice_batchDatagram()

◆ ice_batchOneway()

◆ ice_collocationOptimized()

◆ ice_compress()

◆ ice_connectionCached()

◆ ice_connectionId()

◆ ice_context()

◆ ice_datagram()

◆ ice_encodingVersion()

◆ ice_endpoints()

◆ ice_endpointSelection()

◆ ice_facet()

◆ ice_fixed()

◆ ice_flushBatchRequests()

◆ ice_flushBatchRequestsAsync() [1/2]

◆ ice_flushBatchRequestsAsync() [2/2]

◆ ice_getAdapterId()

◆ ice_getCachedConnection()

◆ ice_getCommunicator()

◆ ice_getCompress()

◆ ice_getConnection()

◆ ice_getConnectionAsync() [1/2]

◆ ice_getConnectionAsync() [2/2]

◆ ice_getConnectionId()

◆ ice_getContext()

◆ ice_getEncodingVersion()

◆ ice_getEndpoints()

◆ ice_getEndpointSelection()

◆ ice_getFacet()

◆ ice_getIdentity()

◆ ice_getInvocationTimeout()

◆ ice_getLocator()

◆ ice_getLocatorCacheTimeout()

◆ ice_getRouter()

◆ ice_getTimeout()

◆ ice_id()

◆ ice_idAsync() [1/2]

◆ ice_idAsync() [2/2]

◆ ice_identity()

◆ ice_ids()

◆ ice_idsAsync() [1/2]

◆ ice_idsAsync() [2/2]

◆ ice_invocationTimeout()

◆ ice_invoke() [1/2]

◆ ice_invoke() [2/2]

◆ ice_invokeAsync() [1/4]

◆ ice_invokeAsync() [2/4]

◆ ice_invokeAsync() [3/4]

◆ ice_invokeAsync() [4/4]

◆ ice_isA()

◆ ice_isAAsync() [1/2]

◆ ice_isAAsync() [2/2]

◆ ice_isBatchDatagram()

◆ ice_isBatchOneway()

◆ ice_isCollocationOptimized()

◆ ice_isConnectionCached()

◆ ice_isDatagram()

◆ ice_isFixed()

◆ ice_isOneway()

◆ ice_isPreferSecure()

◆ ice_isSecure()

◆ ice_isTwoway()

◆ ice_locator()

◆ ice_locatorCacheTimeout()

◆ ice_oneway()

◆ ice_ping()

◆ ice_pingAsync() [1/2]

◆ ice_pingAsync() [2/2]

◆ ice_preferSecure()

◆ ice_router()

◆ ice_secure()

◆ ice_staticId()