Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Znav
nextIce Transport Properties
prevIce Default and Override 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:

Table of Contents
maxLevel2

Anchor
name
name

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.

Ztop

Anchor
name.CollocationOptimized
name.CollocationOptimized

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.

Ztop

Anchor
name.ConnectionCached
name.ConnectionCached

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.

Ztop

Anchor
name.EndpointSelection
name.EndpointSelection

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.

Ztop

Anchor
name.Locator
name.Locator

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:

Wiki Markup
{zcode}
MyProxy.Locator=...
MyProxy.Locator.EndpointSelection=Ordered
{zcode}
Ztop

Anchor
name.LocatorCacheTimeout
name.LocatorCacheTimeout

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.

Ztop

Anchor
name.PreferSecure
name.PreferSecure

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.

Ztop

Anchor
name.Router
name.Router

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:

Wiki Markup
{zcode}
MyProxy.Router=...
MyProxy.Router.PreferSecure=1
{zcode}
Ztop
Zret
Znav
nextIce Transport Properties
prevIce Default and Override Properties