Ice Docs

Proxy Properties

4 min read

4 min read

4 min read

3 min read

4 min read

4 min read

4 min read

4 min read

4 min read

The communicator operation propertyToProxy creates a proxy from a group of configuration properties. The argument to propertyToProxy is a string representing the base name of the property group (shown as name in the property descriptions below). This name must correspond to a property that supplies the stringified form of the proxy. Subordinate properties can be defined to customize the proxy's local configuration.

The communicator operation proxyToProperty performs the inverse operation, that is, returns the property group for a proxy.

name=proxy

The base property of the group with an application-specific name supplying the stringified representation of a proxy. Use the communicator operation propertyToProxy to retrieve the property and convert it into a proxy.

name.CollocationOptimized=num

If num is a value greater than zero, the proxy is configured to use collocated invocations when possible. Defining this property is equivalent to invoking the ice_collocationOptimized proxy method.

name.CollocationOptimized=num

If num is a value greater than zero, the proxy is configured to use collocated invocations when possible, including calls to the communicator's Ice.Admin object adapter.

name.ConnectionCached=num

If num is a value greater than zero, the proxy caches its chosen connection for use in subsequent requests. Defining this property is equivalent to invoking the ice_connectionCached proxy method.

name.Context.key=value

Adds the key/value pair to the proxy's request context.

name.EndpointSelection=type

Specifies the proxy's endpoint selection type. Legal values are Random and Ordered. Defining this property is equivalent to invoking the ice_endpointSelection proxy method.

name.InvocationTimeout=num

Specifies the invocation timeout of this proxy, in milliseconds. The default is Ice.Default.InvocationTimeout. Defining this property is equivalent to invoking the ice_invocationTimeout proxy method.

name.Locator=proxy

Specifies the locator of this proxy. Defining this property is equivalent to invoking the ice_locator proxy method.

This is a proxy property, so you can configure additional local aspects of the proxy with subordinate properties. For example:

Properties
MyProxy.Locator=...
MyProxy.Locator.EndpointSelection=Ordered

name.LocatorCacheTimeout=num

Specifies the locator cache timeout of this proxy, in seconds. The default is Ice.Default.LocatorCacheTimeout. A value of 0 disables caching. A negative value means cache entries never expire.

name.Router=proxy

Specifies the router of this proxy. Defining this property is equivalent to invoking the ice_router proxy method.

This is a proxy property, so you can configure additional local aspects of the proxy with subordinate properties. For example:

Properties
MyProxy.Router=...
MyProxy.Router.EndpointSelection=Ordered