Proxy Properties
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.
On this page:
name
Synopsis
name=proxy
Description
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
Synopsis
name.CollocationOptimized=num
Description
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.ConnectionCached
Synopsis
name.ConnectionCached=num
Description
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
Synopsis
name.Context.key=value
Description
Adds the key/value pair to the proxy's request context.
name.EndpointSelection
Synopsis
name.EndpointSelection=type
Description
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
Synopsis
name.InvocationTimeout=num
Description
Specifies the invocation timeout to be used by this proxy. Defining this property is equivalent to invoking the ice_invocationTimeout proxy method.
name.Locator
Synopsis
name.Locator=proxy
Description
Specifies the proxy of the locator to be used by 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:
MyProxy.Locator=... MyProxy.Locator.EndpointSelection=Ordered
name.LocatorCacheTimeout
Synopsis
name.LocatorCacheTimeout=num
Description
Specifies the locator cache timeout to be used by this proxy. Defining this property is equivalent to invoking the ice_locatorCacheTimeout proxy method.
name.PreferSecure
Synopsis
name.PreferSecure=num
Description
If num is a value greater than zero, the proxy gives precedence to secure endpoints. If not defined, the proxy uses the value of Ice.Default.PreferSecure.
Defining this property is equivalent to invoking the ice_preferSecure proxy method.
name.Router
Synopsis
name.Router=proxy
Description
Specifies the proxy of the router to be used by 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:
MyProxy.Router=... MyProxy.Router.PreferSecure=1