Table 32.1. The semantics of core proxy methods. |
|||
Method |
Description |
Remote |
|
ice_isA |
Returns true if the remote object supports the type indicated by the id argument, otherwise false. This method can only be invoked on a twoway proxy. |
Yes |
|
ice_ping |
Determines whether the remote object is reachable. Does not return a value. |
Yes |
|
ice_ids |
Returns the type ids of the types supported by the remote object. The return value is an array of strings. This method can only be invoked on a twoway proxy. |
Yes |
|
ice_id |
Returns the type id of the most-derived type supported by the remote object. This method can only be invoked on a twoway proxy. |
Yes |
|
ice_getHash |
Returns a hash value for the proxy for C++. For other language mappings, use the built-in hash method. |
No |
|
ice_getCommunicator |
Returns the communicator that was used to create this proxy. |
No |
|
ice_toString |
Returns the string representation of the proxy. |
No |
|
ice_identity |
Returns a new proxy having the given identity. |
No |
|
ice_getIdentity |
Returns the identity of the Ice object represented by the proxy. |
No |
|
ice_adapterId |
Returns a new proxy having the given adapter id. |
No |
|
ice_getAdapterId |
Returns the proxy’s adapter id, or an empty string if no adapter id is configured. |
No |
|
ice_endpoints |
Returns a new proxy having the given endpoints. |
No |
|
ice_getEndpoints |
No |
||
ice_endpointSelection |
No |
||
ice_getEndpointSelection |
Returns the endpoint selection policy for the proxy. |
No |
|
ice_context |
No |
||
ice_getContext |
No |
||
ice_facet |
Returns a new proxy having the given facet name. See Chapter 33 for more information on facets. |
No |
|
ice_getFacet |
No |
||
ice_twoway |
Returns a new proxy for making twoway invocations. |
No |
|
ice_isTwoway |
Returns true if the proxy uses twoway invocations, otherwise false. |
No |
|
ice_oneway |
Returns a new proxy for making oneway invocations (see Section 32.14). |
No |
|
ice_isOneway |
Returns true if the proxy uses oneway invocations, otherwise false. |
No |
|
ice_batchOneway |
Returns a new proxy for making batch oneway invocations (see Section 32.16). |
No |
|
ice_isBatchOneway |
Returns true if the proxy uses batch oneway invocations, otherwise false. |
No |
|
ice_datagram |
Returns a new proxy for making datagram invocations (see Section 32.15). |
No |
|
ice_isDatagram |
Returns true if the proxy uses datagram invocations, otherwise false. |
No |
|
ice_batchDatagram |
Returns a new proxy for making batch datagram invocations (see Section 32.16). |
No |
|
ice_isBatchDatagram |
Returns true if the proxy uses batch datagram invocations, otherwise false. |
No |
|
ice_secure |
Returns a new proxy whose endpoints may be filtered depending on the boolean argument. If true, only endpoints using secure transports are allowed, otherwise all endpoints are allowed. |
No |
|
ice_isSecure |
Returns true if the proxy uses only secure endpoints, otherwise false. |
No |
|
ice_preferSecure |
Returns a new proxy whose endpoints are filtered depending on the boolean argument. If true, endpoints using secure transports are given precedence over endpoints using non-secure transports. If false, the default behavior gives precedence to endpoints using non-secure transports. |
No |
|
ice_isPreferSecure |
Returns true if the proxy prefers secure endpoints, otherwise false. |
No |
|
ice_compress |
Returns a new proxy whose protocol compression capability is determined by the boolean argument. If true, the proxy uses protocol compression if it is supported by the endpoint. If false, protocol compression is never used. |
No |
|
ice_timeout |
No |
||
ice_router |
No |
||
ice_getRouter |
Returns the router that is configured for the proxy (null if no router is configured). |
No |
|
ice_locator |
Returns a new proxy with the specified locator. See Chapter 38 for more information on locators. |
No |
|
ice_getLocator |
Returns the locator that is configured for the proxy (null if no locator is configured). |
No |
|
ice_locatorCacheTimeout |
Returns a new proxy with the specified locator cache timeout. When binding a proxy to an endpoint, the run time caches the proxy returned by the locator and uses the cached proxy while the cached proxy has been in the cache for less than the timeout. Proxies older than the timeout cause the run time to rebind via the locator. A value of 0 disables caching entirely, and a value of ‑1 means that cached proxies never expire. The default value is ‑1. |
No |
|
ice_getLocatorCacheTimeout |
Returns the locator cache timeout value in seconds. |
No |
|
ice_collocationOptimized |
Returns a new proxy configured for collocation optimization. If true, collocated optimizations are enabled. The default value is true. |
No |
|
ice_isCollocationOptimized |
Returns true if the proxy uses collocation optimization, otherwise false. |
No |
|
ice_connectionId |
No |
||
ice_getConnectionId |
Returns the connection id, or an empty string if no connection id has been configured. |
No |
|
ice_getConnection |
No |
||
ice_getCachedConnection |
No |
||
ice_connectionCached |
Enables or disables connection caching for the proxy. See Section 36.3.4 for more information |
No |
|
ice_isConnectionCached |
Returns true if the proxy uses connection caching, otherwise false. |
No |
|
ice_flushBatchRequests |
Sends a batch of operation invocations synchronously or asynchronously (see Section 32.16). |
Yes |
|
begin_ice_flushBatchRequests |
|||
ice_invoke |
Allows dynamic invocation of an operation without the need for compiled Slice definitions. Requests can be sent synchronously (see Section 35.3.1) or asynchronously (see Section 35.4). |
Yes |
|
begin_ice_invoke |
|||