Ice Docs

Ice.Default.*

6 min read

6 min read

6 min read

5 min read

6 min read

6 min read

6 min read

6 min read

6 min read

Ice.Default.CollocationOptimized=num

Specifies whether proxy invocations use collocation optimization by default. When enabled, proxy invocations on a collocated servant (i.e., a servant whose object adapter was created by the same communicator as the proxy) are made more efficiently by avoiding the network stack.

If not specified, the default value is 1. Set the property to 0 to disable collocation optimization by default.

Ice.Default.EncodingVersion=ver

If this property is not defined, Ice uses encoding version 1.1 when parsing a string that represents a proxy if this string does not specify an encoding with the -e option. To use encoding version 1.0 as the default instead, set this property to 1.0:

Ice.Default.EncodingVersion=1.0

Ice.Default.EndpointSelection=policy

This property controls the default endpoint selection policy for proxies with multiple endpoints. Permissible values are Ordered and Random. The default value of this property is Random.

Ice.Default.Host=host

If an endpoint does not specify a host name (i.e., omits the -h host option in IP-based endpoints or the -a address option in a Bluetooth endpoint), the host value from this property is used instead. This property applies to both client and server endpoints. It has no default value.

Ice.Default.InvocationTimeout=num

Specifies the default invocation timeout in milliseconds to use for all proxies. The default value is -1, which disables the timeout.

Ice.Default.Locator=locator

Specifies a default locator for all proxies and object adapters. The value is a stringified proxy for the IceGrid locator object. The default locator can be overridden on a proxy using the ice_locator proxy methodproxy methodproxy methodproxy methodproxy methodproxy methodproxy methodproxy method. The default value is no locator.

The default identity of the IceGrid locator object is IceGrid/Locator, but this identity is influenced by the IceGrid.InstanceName property. The locator object is available on the IceGrid client endpoints. For example, suppose IceGrid.Registry.Client.Endpoints is set as follows:

Properties
IceGrid.Registry.Client.Endpoints=tcp -p 12000 -h localhost

In this case, the stringified proxy for the IceGrid locator is:

Properties
Ice.Default.Locator=IceGrid/Locator:tcp -p 12000 -h localhost

As a proxy property, you can configure additional aspects of the proxy using properties.

Ice.Default.LocatorCacheTimeout=num

Specifies the default locator cache timeout for indirect proxies, in seconds. If num is greater than 0, locator cache entries older than num seconds are ignored. If set to 0, the locator cache is not used. The default value, -1, means cache entries do not expire.

Once a cache entry has expired, the Ice runtime performs a new locate request to refresh the cache before sending the next invocation; therefore, the invocation is delayed until the runtime has refreshed the entry. If you set Ice.BackgroundLocatorCacheUpdates to a non-zero value, the lookup to refresh the cache is still performed but happens in the background; this avoids the delay for the first invocation that follows expiry of a cache entry.

Ice.Default.Package=package

Ice for Java allows you to customize the Slice module to Java package mapping with the java:package and java:identifier metadata directive.

When you use this feature, you need to help Ice locate your remapped classes during unmarshaling, by installing a Slice loader in your communicator. The Ice.Default.Package property tells the Ice communicator to install automatically a DefaultPackageSliceLoader during initialization, configured using the value of this property.

This property is provided primarily for backwards compatibility; we recommend configuring Slice loaders programmatically in new applications.

See also: Ice.Package.module

Ice.Default.Protocol=transport protocol

Sets the transport protocol that is being used if an endpoint uses default as the transport protocol specification.

The default value is tcp.

The default value is ws in a browser and tcp in Node.js.

Ice.Default.Router=router

Specifies the default router for all proxies. The value is a stringified proxy for the Glacier2 router control interface. The default router can be overridden on a proxy using the ice_router proxy methodproxy methodproxy methodproxy methodproxy methodproxy methodproxy methodproxy method. The default value is no router. This property is only for proxies: it does not add a router to object adapters.

As a proxy property, you can configure additional aspects of the proxy using properties.

Ice.Default.SlicedFormat=num

Specifies the encoding format of Slice classes. The default value is 0, which selects the compact format; 1 selects the sliced format. This property applies to version 1.1 of the Ice encoding.

Note that you can also specify whether certain operations use the sliced format by annotating their definitions with metadata.

Ice.Default.SourceAddress=addr

Specifies the numeric IP address used to bind outgoing socket connections, except stream connections on iOS. Selecting a source IP address does not necessarily select the network interface used to send packets. Proxy endpoints can override this default with the --sourceAddress option. If this property is empty, the operating system selects the source address.

In Node.js, this property supplies the local address for outgoing TCP connections. Proxy endpoints can override it with the --sourceAddress option. WebSocket connections use the source address selected by the operating system.