Base class of all object proxies. More...

#include <Ice/Ice.h>

Inheritance diagram for IceProxy::Ice::Object:

[legend]

Collaboration diagram for IceProxy::Ice::Object:

[legend]

Public Member Functions
::Ice::AsyncResultPtr	begin_ice_flushBatchRequests ()
	Flushes asynchronously any pending batched requests for this proxy.
::Ice::AsyncResultPtr	begin_ice_flushBatchRequests (const ::Ice::Callback_Object_ice_flushBatchRequestsPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Flushes asynchronously any pending batched requests for this proxy.
::Ice::AsyncResultPtr	begin_ice_flushBatchRequests (const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Flushes asynchronously any pending batched requests for this proxy.
::Ice::AsyncResultPtr	begin_ice_getConnection ()
	Obtains the Connection for this proxy.
::Ice::AsyncResultPtr	begin_ice_getConnection (const ::Ice::Callback_Object_ice_getConnectionPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Obtains the Connection for this proxy.
::Ice::AsyncResultPtr	begin_ice_getConnection (const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Obtains the Connection for this proxy.
::Ice::AsyncResultPtr	begin_ice_id (const ::Ice::Callback_Object_ice_idPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_ice_id (const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_ice_id (const ::Ice::Context &context, const ::Ice::Callback_Object_ice_idPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_ice_id (const ::Ice::Context &context, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_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.
::Ice::AsyncResultPtr	begin_ice_ids (const ::Ice::Callback_Object_ice_idsPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_ice_ids (const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_ice_ids (const ::Ice::Context &context, const ::Ice::Callback_Object_ice_idsPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_ice_ids (const ::Ice::Context &context, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_ice_ids (const ::Ice::Context &context=::Ice::noExplicitContext)
	Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams, const ::Ice::Callback_Object_ice_invokePtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams, const ::Ice::Context &context, const ::Ice::Callback_Object_ice_invokePtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams, const ::Ice::Context &context, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &inParams, const ::Ice::Context &context, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< ::Ice::Byte > &inParams)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< ::Ice::Byte > &inParams, const ::Ice::Callback_Object_ice_invokePtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< ::Ice::Byte > &inParams, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< ::Ice::Byte > &inParams, const ::Ice::Context &context)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< ::Ice::Byte > &inParams, const ::Ice::Context &context, const ::Ice::Callback_Object_ice_invokePtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< ::Ice::Byte > &inParams, const ::Ice::Context &context, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Invokes an operation dynamically.
::Ice::AsyncResultPtr	begin_ice_isA (const ::std::string &typeId, const ::Ice::Callback_Object_ice_isAPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Tests whether this object supports a specific Slice interface.
::Ice::AsyncResultPtr	begin_ice_isA (const ::std::string &typeId, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Tests whether this object supports a specific Slice interface.
::Ice::AsyncResultPtr	begin_ice_isA (const ::std::string &typeId, const ::Ice::Context &context, const ::Ice::Callback_Object_ice_isAPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Tests whether this object supports a specific Slice interface.
::Ice::AsyncResultPtr	begin_ice_isA (const ::std::string &typeId, const ::Ice::Context &context, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Tests whether this object supports a specific Slice interface.
::Ice::AsyncResultPtr	begin_ice_isA (const ::std::string &typeId, const ::Ice::Context &context=::Ice::noExplicitContext)
	Tests whether this object supports a specific Slice interface.
::Ice::AsyncResultPtr	begin_ice_ping (const ::Ice::Callback_Object_ice_pingPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Tests whether the target object of this proxy can be reached.
::Ice::AsyncResultPtr	begin_ice_ping (const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Tests whether the target object of this proxy can be reached.
::Ice::AsyncResultPtr	begin_ice_ping (const ::Ice::Context &context, const ::Ice::Callback_Object_ice_pingPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Tests whether the target object of this proxy can be reached.
::Ice::AsyncResultPtr	begin_ice_ping (const ::Ice::Context &context, const ::Ice::CallbackPtr &cb, const ::Ice::LocalObjectPtr &cookie=0)
	Tests whether the target object of this proxy can be reached.
::Ice::AsyncResultPtr	begin_ice_ping (const ::Ice::Context &context=::Ice::noExplicitContext)
	Tests whether the target object of this proxy can be reached.
void	end_ice_flushBatchRequests (const ::Ice::AsyncResultPtr &result)
	Completes an invocation of begin_ice_flushBatchRequests.
::Ice::ConnectionPtr	end_ice_getConnection (const ::Ice::AsyncResultPtr &result)
	Completes an invocation of begin_ice_getConnection.
::std::string	end_ice_id (const ::Ice::AsyncResultPtr &result)
	Completes an invocation of begin_ice_id.
::std::vector< ::std::string >	end_ice_ids (const ::Ice::AsyncResultPtr &result)
	Completes an invocation of begin_ice_ids.
bool	end_ice_invoke (::std::vector< ::Ice::Byte > &outParams, const ::Ice::AsyncResultPtr &result)
	Invokes an operation dynamically.
bool	end_ice_isA (const ::Ice::AsyncResultPtr &result)
	Completes an invocation of begin_ice_isA.
void	end_ice_ping (const ::Ice::AsyncResultPtr &result)
	Completes an invocation of begin_ice_ping.
::Ice::ObjectPrx	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID.
::Ice::ObjectPrx	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations.
::Ice::ObjectPrx	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations.
::Ice::ObjectPrx	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization.
::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.
::Ice::ObjectPrx	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching.
::Ice::ObjectPrx	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID.
::Ice::ObjectPrx	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context.
::Ice::ObjectPrx	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations.
::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.
::Ice::ObjectPrx	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints.
::Ice::ObjectPrx	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy.
::Ice::ObjectPrx	ice_facet (const ::std::string &facet) const
	Obtains a proxy that is identical to this proxy, except for the facet.
::Ice::ObjectPrx	ice_fixed (const ::Ice::ConnectionPtr &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.
void	ice_flushBatchRequests ()
	Flushes any pending batched requests for this proxy.
::std::string	ice_getAdapterId () const
	Obtains the adapter ID for this proxy.
::Ice::ConnectionPtr	ice_getCachedConnection () const
	Returns the cached connection for this proxy.
::Ice::CommunicatorPtr	ice_getCommunicator () const
	Obtains the communicator that created this proxy.
::IceUtil::Optional< bool >	ice_getCompress () const
	Obtains the compression override setting of this proxy.
::Ice::ConnectionPtr	ice_getConnection ()
	Obtains the Connection for this proxy.
::std::string	ice_getConnectionId () const
	Obtains the connection ID of this proxy.
::Ice::Context	ice_getContext () const
	Obtains the per-proxy context for this proxy.
::Ice::EncodingVersion	ice_getEncodingVersion () const
	Obtains the encoding version used to marshal request parameters.
::Ice::EndpointSeq	ice_getEndpoints () const
	Obtains the endpoints used by this proxy.
::Ice::EndpointSelectionType	ice_getEndpointSelection () const
	Obtains the endpoint selection policy for this proxy (randomly or ordered).
const ::std::string &	ice_getFacet () const
	Obtains the facet for this proxy.
::Ice::Identity	ice_getIdentity () const
	Obtains the identity embedded in this proxy.
::Ice::Int	ice_getInvocationTimeout () const
	Obtains the invocation timeout of this proxy.
::Ice::LocatorPrx	ice_getLocator () const
	Obtains the locator for this proxy.
::Ice::Int	ice_getLocatorCacheTimeout () const
	Obtains the locator cache timeout of this proxy.
::Ice::RouterPrx	ice_getRouter () const
	Obtains the router for this proxy.
::IceUtil::Optional< int >	ice_getTimeout () const
	Obtains the timeout override of this proxy.
::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.
::Ice::ObjectPrx	ice_identity (const ::Ice::Identity &id) const
	Obtains a proxy that is identical to this proxy, except for the identity.
::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.
::Ice::ObjectPrx	ice_invocationTimeout (::Ice::Int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout.
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.
bool	ice_invoke (const ::std::string &operation, ::Ice::OperationMode mode, const ::std::vector< ::Ice::Byte > &inParams, ::std::vector< ::Ice::Byte > &outParams, const ::Ice::Context &context=::Ice::noExplicitContext)
	Invokes an operation dynamically.
bool	ice_isA (const ::std::string &typeId, const ::Ice::Context &context=::Ice::noExplicitContext)
	Tests whether this object supports a specific Slice interface.
bool	ice_isBatchDatagram () const
	Determines whether this proxy uses batch datagram invocations.
bool	ice_isBatchOneway () const
	Determines whether this proxy uses batch oneway invocations.
bool	ice_isCollocationOptimized () const
	Determines whether this proxy uses collocation optimization.
bool	ice_isConnectionCached () const
	Determines whether this proxy caches connections.
bool	ice_isDatagram () const
	Determines whether this proxy uses datagram invocations.
bool	ice_isFixed () const
	Determines whether this proxy is a fixed proxy.
bool	ice_isOneway () const
	Determines whether this proxy uses oneway invocations.
bool	ice_isPreferSecure () const
	Determines whether this proxy prefers secure endpoints.
bool	ice_isSecure () const
	Determines whether this proxy uses only secure endpoints.
bool	ice_isTwoway () const
	Determines whether this proxy uses twoway invocations.
::Ice::ObjectPrx	ice_locator (const ::Ice::LocatorPrx &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator.
::Ice::ObjectPrx	ice_locatorCacheTimeout (::Ice::Int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout.
::Ice::ObjectPrx	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations.
void	ice_ping (const ::Ice::Context &context=::Ice::noExplicitContext)
	Tests whether the target object of this proxy can be reached.
::Ice::ObjectPrx	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy.
::Ice::ObjectPrx	ice_router (const ::Ice::RouterPrx &router) const
	Obtains a proxy that is identical to this proxy, except for the router.
::Ice::ObjectPrx	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints.
::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.
::std::string	ice_toString () const
	Obtains a stringified version of this proxy.
::Ice::ObjectPrx	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations.
bool	operator< (const Object &) const
bool	operator== (const Object &) const
Public Member Functions inherited from IceUtil::Shared
void	__clearFlag (unsigned char flag)
virtual void	__decRef ()
virtual int	__getRef () const
bool	__hasFlag (unsigned char flag)
virtual void	__incRef ()
void	__setFlag (unsigned char flag)
virtual void	__setNoDelete (bool)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

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

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

Detailed Description

Base class of all object proxies.

Member Function Documentation

◆ begin_ice_flushBatchRequests() [1/3]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_flushBatchRequests ( )

inline

Flushes asynchronously any pending batched requests for this proxy.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_flushBatchRequests() [2/3]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_flushBatchRequests	(	const ::Ice::Callback_Object_ice_flushBatchRequestsPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

Flushes asynchronously any pending batched requests for this proxy.

Parameters

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_flushBatchRequests() [3/3]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_flushBatchRequests	(	const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

Flushes asynchronously any pending batched requests for this proxy.

Parameters

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_getConnection() [1/3]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_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 asynchronous result object for the invocation.

◆ begin_ice_getConnection() [2/3]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_getConnection	(	const ::Ice::Callback_Object_ice_getConnectionPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_getConnection() [3/3]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_getConnection	(	const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_id() [1/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_id	(	const ::Ice::Callback_Object_ice_idPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

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

Parameters

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_id() [2/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_id	(	const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

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

Parameters

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_id() [3/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_id	(	const ::Ice::Context &	context,
		const ::Ice::Callback_Object_ice_idPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_id() [4/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_id	(	const ::Ice::Context &	context,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_id() [5/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_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 asynchronous result object for the invocation.

◆ begin_ice_ids() [1/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_ids	(	const ::Ice::Callback_Object_ice_idsPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

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

Parameters

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_ids() [2/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_ids	(	const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

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

Parameters

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_ids() [3/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_ids	(	const ::Ice::Context &	context,
		const ::Ice::Callback_Object_ice_idsPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_ids() [4/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_ids	(	const ::Ice::Context &	context,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_ids() [5/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_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 asynchronous result object for the invocation.

◆ begin_ice_invoke() [1/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams )

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.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [2/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams,
		const ::Ice::Callback_Object_ice_invokePtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [3/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [4/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams,
		const ::Ice::Context &	context,
		const ::Ice::Callback_Object_ice_invokePtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [5/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams,
		const ::Ice::Context &	context,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [6/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::pair< const ::Ice::Byte , const ::Ice::Byte > &	inParams,
		const ::Ice::Context &	context,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [7/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< ::Ice::Byte > &	inParams )

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.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [8/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< ::Ice::Byte > &	inParams,
		const ::Ice::Callback_Object_ice_invokePtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [9/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< ::Ice::Byte > &	inParams,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [10/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< ::Ice::Byte > &	inParams,
		const ::Ice::Context &	context )

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 asynchronous result object for the invocation.

◆ begin_ice_invoke() [11/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< ::Ice::Byte > &	inParams,
		const ::Ice::Context &	context,
		const ::Ice::Callback_Object_ice_invokePtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_invoke() [12/12]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< ::Ice::Byte > &	inParams,
		const ::Ice::Context &	context,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_isA() [1/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_isA	(	const ::std::string &	typeId,
		const ::Ice::Callback_Object_ice_isAPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

Tests whether this object supports a specific Slice interface.

Parameters

typeId	The type ID of the Slice interface to test against.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_isA() [2/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_isA	(	const ::std::string &	typeId,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

Tests whether this object supports a specific Slice interface.

Parameters

typeId	The type ID of the Slice interface to test against.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_isA() [3/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_isA	(	const ::std::string &	typeId,
		const ::Ice::Context &	context,
		const ::Ice::Callback_Object_ice_isAPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_isA() [4/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_isA	(	const ::std::string &	typeId,
		const ::Ice::Context &	context,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

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.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_isA() [5/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_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: The asynchronous result object for the invocation.

◆ begin_ice_ping() [1/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_ping	(	const ::Ice::Callback_Object_ice_pingPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

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

Parameters

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_ping() [2/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_ping	(	const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

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

Parameters

cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_ping() [3/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_ping	(	const ::Ice::Context &	context,
		const ::Ice::Callback_Object_ice_pingPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

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

Parameters

context	The context map for the invocation.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_ping() [4/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_ice_ping	(	const ::Ice::Context &	context,
		const ::Ice::CallbackPtr &	cb,
		const ::Ice::LocalObjectPtr &	cookie = 0 )

inline

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

Parameters

context	The context map for the invocation.
cb	Asynchronous callback object.
cookie	User-defined data to associate with the invocation.

Returns: The asynchronous result object for the invocation.

◆ begin_ice_ping() [5/5]

::Ice::AsyncResultPtr IceProxy::Ice::Object::begin_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.

Returns: The asynchronous result object for the invocation.

◆ end_ice_flushBatchRequests()

void IceProxy::Ice::Object::end_ice_flushBatchRequests ( const ::Ice::AsyncResultPtr & result )

Completes an invocation of begin_ice_flushBatchRequests.

Parameters

result The asynchronous result object for the invocation.

◆ end_ice_getConnection()

::Ice::ConnectionPtr IceProxy::Ice::Object::end_ice_getConnection ( const ::Ice::AsyncResultPtr & result )

Completes an invocation of begin_ice_getConnection.

Parameters

result The asynchronous result object for the invocation.

Returns: The connection for this proxy.

◆ end_ice_id()

::std::string IceProxy::Ice::Object::end_ice_id ( const ::Ice::AsyncResultPtr & result )

Completes an invocation of begin_ice_id.

Parameters

result The asynchronous result object for the invocation.

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

◆ end_ice_ids()

::std::vector< ::std::string > IceProxy::Ice::Object::end_ice_ids ( const ::Ice::AsyncResultPtr & result )

Completes an invocation of begin_ice_ids.

Parameters

result The asynchronous result object 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".

◆ end_ice_invoke()

bool IceProxy::Ice::Object::end_ice_invoke	(	::std::vector< ::Ice::Byte > &	outParams,
		const ::Ice::AsyncResultPtr &	result )

Invokes an operation dynamically.

Parameters

outParams	An encapsulation containing the encoded results.
result	The asynchronous result object 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.

◆ end_ice_isA()

bool IceProxy::Ice::Object::end_ice_isA ( const ::Ice::AsyncResultPtr & result )

Completes an invocation of begin_ice_isA.

Parameters

result The asynchronous result object for the invocation.

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

◆ end_ice_ping()

void IceProxy::Ice::Object::end_ice_ping ( const ::Ice::AsyncResultPtr & result )

Completes an invocation of begin_ice_ping.

Parameters

result The asynchronous result object for the invocation.

◆ ice_adapterId()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::ice_fixed ( const ::Ice::ConnectionPtr & 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 IceProxy::Ice::Object::ice_flushBatchRequests ( )

inline

Flushes any pending batched requests for this proxy.

The call blocks until the flush is complete.

◆ ice_getAdapterId()

::std::string IceProxy::Ice::Object::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()

::Ice::ConnectionPtr IceProxy::Ice::Object::ice_getCachedConnection ( ) const

Returns 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()

::Ice::CommunicatorPtr IceProxy::Ice::Object::ice_getCommunicator ( ) const

Obtains the communicator that created this proxy.

Returns: The communicator that created this proxy.

◆ ice_getCompress()

::IceUtil::Optional< bool > IceProxy::Ice::Object::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()

::Ice::ConnectionPtr IceProxy::Ice::Object::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_getConnectionId()

::std::string IceProxy::Ice::Object::ice_getConnectionId ( ) const

Obtains the connection ID of this proxy.

Returns: The connection ID.

◆ ice_getContext()

::Ice::Context IceProxy::Ice::Object::ice_getContext ( ) const

Obtains the per-proxy context for this proxy.

Returns: The per-proxy context.

◆ ice_getEncodingVersion()

::Ice::EncodingVersion IceProxy::Ice::Object::ice_getEncodingVersion ( ) const

Obtains the encoding version used to marshal request parameters.

Returns: The encoding version.

◆ ice_getEndpoints()

::Ice::EndpointSeq IceProxy::Ice::Object::ice_getEndpoints ( ) const

Obtains the endpoints used by this proxy.

Returns: The endpoints used by this proxy.

◆ ice_getEndpointSelection()

::Ice::EndpointSelectionType IceProxy::Ice::Object::ice_getEndpointSelection ( ) const

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

Returns: The endpoint selection policy.

◆ ice_getFacet()

const ::std::string & IceProxy::Ice::Object::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 IceProxy::Ice::Object::ice_getIdentity ( ) const

Obtains the identity embedded in this proxy.

Returns: The identity of the target object.

◆ ice_getInvocationTimeout()

::Ice::Int IceProxy::Ice::Object::ice_getInvocationTimeout ( ) const

Obtains the invocation timeout of this proxy.

Returns: The invocation timeout value (in milliseconds).

◆ ice_getLocator()

::Ice::LocatorPrx IceProxy::Ice::Object::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 IceProxy::Ice::Object::ice_getLocatorCacheTimeout ( ) const

Obtains the locator cache timeout of this proxy.

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

◆ ice_getRouter()

::Ice::RouterPrx IceProxy::Ice::Object::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()

::IceUtil::Optional< int > IceProxy::Ice::Object::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 IceProxy::Ice::Object::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_identity()

::Ice::ObjectPrx IceProxy::Ice::Object::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 > IceProxy::Ice::Object::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_invocationTimeout()

::Ice::ObjectPrx IceProxy::Ice::Object::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 IceProxy::Ice::Object::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 IceProxy::Ice::Object::ice_invoke	(	const ::std::string &	operation,
		::Ice::OperationMode	mode,
		const ::std::vector< ::Ice::Byte > &	inParams,
		::std::vector< ::Ice::Byte > &	outParams,
		const ::Ice::Context &	context = ::Ice::noExplicitContext )

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_isA()

bool IceProxy::Ice::Object::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_isBatchDatagram()

bool IceProxy::Ice::Object::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 IceProxy::Ice::Object::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 IceProxy::Ice::Object::ice_isCollocationOptimized ( ) const

Determines whether this proxy uses collocation optimization.

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

◆ ice_isConnectionCached()

bool IceProxy::Ice::Object::ice_isConnectionCached ( ) const

Determines whether this proxy caches connections.

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

◆ ice_isDatagram()

bool IceProxy::Ice::Object::ice_isDatagram ( ) const

Determines whether this proxy uses datagram invocations.

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

◆ ice_isFixed()

bool IceProxy::Ice::Object::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 IceProxy::Ice::Object::ice_isOneway ( ) const

Determines whether this proxy uses oneway invocations.

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

◆ ice_isPreferSecure()

bool IceProxy::Ice::Object::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 IceProxy::Ice::Object::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 IceProxy::Ice::Object::ice_isTwoway ( ) const

Determines whether this proxy uses twoway invocations.

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

◆ ice_locator()

::Ice::ObjectPrx IceProxy::Ice::Object::ice_locator ( const ::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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 IceProxy::Ice::Object::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_preferSecure()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

::Ice::ObjectPrx IceProxy::Ice::Object::ice_router ( const ::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()

::Ice::ObjectPrx IceProxy::Ice::Object::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()

const ::std::string & IceProxy::Ice::Object::ice_staticId ( )

inlinestatic

Returns the Slice type ID associated with this type.

Returns: The Slice type ID.

◆ ice_timeout()

::Ice::ObjectPrx IceProxy::Ice::Object::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 IceProxy::Ice::Object::ice_toString ( ) const

Obtains a stringified version of this proxy.

Returns: A stringified proxy.

◆ ice_twoway()

::Ice::ObjectPrx IceProxy::Ice::Object::ice_twoway ( ) const

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

Returns: A proxy that uses twoway invocations.

◆ operator<()

bool IceProxy::Ice::Object::operator< ( const Object & ) const

◆ operator==()

bool IceProxy::Ice::Object::operator== ( const Object & ) const

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

Ice/Proxy.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ begin_ice_flushBatchRequests() [1/3]

◆ begin_ice_flushBatchRequests() [2/3]

◆ begin_ice_flushBatchRequests() [3/3]

◆ begin_ice_getConnection() [1/3]

◆ begin_ice_getConnection() [2/3]

◆ begin_ice_getConnection() [3/3]

◆ begin_ice_id() [1/5]

◆ begin_ice_id() [2/5]

◆ begin_ice_id() [3/5]

◆ begin_ice_id() [4/5]

◆ begin_ice_id() [5/5]

◆ begin_ice_ids() [1/5]

◆ begin_ice_ids() [2/5]

◆ begin_ice_ids() [3/5]

◆ begin_ice_ids() [4/5]

◆ begin_ice_ids() [5/5]

◆ begin_ice_invoke() [1/12]

◆ begin_ice_invoke() [2/12]

◆ begin_ice_invoke() [3/12]

◆ begin_ice_invoke() [4/12]

◆ begin_ice_invoke() [5/12]

◆ begin_ice_invoke() [6/12]

◆ begin_ice_invoke() [7/12]

◆ begin_ice_invoke() [8/12]

◆ begin_ice_invoke() [9/12]

◆ begin_ice_invoke() [10/12]

◆ begin_ice_invoke() [11/12]

◆ begin_ice_invoke() [12/12]

◆ begin_ice_isA() [1/5]

◆ begin_ice_isA() [2/5]

◆ begin_ice_isA() [3/5]

◆ begin_ice_isA() [4/5]

◆ begin_ice_isA() [5/5]

◆ begin_ice_ping() [1/5]

◆ begin_ice_ping() [2/5]

◆ begin_ice_ping() [3/5]

◆ begin_ice_ping() [4/5]

◆ begin_ice_ping() [5/5]

◆ end_ice_flushBatchRequests()

◆ end_ice_getConnection()

◆ end_ice_id()

◆ end_ice_ids()

◆ end_ice_invoke()

◆ end_ice_isA()

◆ end_ice_ping()

◆ 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_getAdapterId()

◆ ice_getCachedConnection()

◆ ice_getCommunicator()

◆ ice_getCompress()

◆ ice_getConnection()

◆ ice_getConnectionId()

◆ ice_getContext()

◆ ice_getEncodingVersion()

◆ ice_getEndpoints()

◆ ice_getEndpointSelection()

◆ ice_getFacet()

◆ ice_getIdentity()

◆ ice_getInvocationTimeout()

◆ ice_getLocator()

◆ ice_getLocatorCacheTimeout()