Ice.Default.*

On this page:

Ice.Default.CollocationOptimized

Synopsis

Ice.Default.CollocationOptimized=num

Description

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

Synopsis

Ice.Default.EncodingVersion=ver

Description

If this property is not defined, Ice 3.5 uses encoding version 1.1 by default. To force the Ice run time to use encoding version 1.0 as the default instead, set this property to 1.0:

Ice.Default.EncodingVersion=1.0

Ice.Default.EndpointSelection

Synopsis

Ice.Default.EndpointSelection=policy

Description

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

Synopsis

Ice.Default.Host=host

Description

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

Synopsis

Ice.Default.InvocationTimeout=num

Description

Specifies the default invocation timeout in milliseconds to use for all proxies. If not defined, the default timeout is -1, which means an invocation never times out.

If set to -2, invocation timeouts are disabled and the Ice run time behaves like Ice versions < 3.6: it uses connection timeouts (defined on the endpoints) to wait for the response of the invocation. This setting is provided only for backward compatibility and might be deprecated in a future Ice major release.

Ice.Default.Locator

Synopsis

Ice.Default.Locator=locator

Description

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 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:

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

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

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

Synopsis

Ice.Default.LocatorCacheTimeout=num

Description

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

Once a cache entry has expired, the Ice run time performs a new locate request to refresh the cache before sending the next invocation; therefore, the invocation is delayed until the run time has refreshed the entry. If you set Ice.BackgroundLocatorCacheUpdates to a non-0value, 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

Synopsis

Ice.Default.Package=package (Java)

Description

Ice for Java allows you to customize the packaging of generated code. If you use this feature, the Ice run time requires additional configuration in order to successfully unmarshal exceptions and concrete class types. This property specifies a default package to use if other attempts by the Ice run time to dynamically load a generated class have failed. Also see Ice.Package.module.

Ice.Default.PreferSecure

Synopsis

Ice.Default.PreferSecure=num

Description

Specifies whether secure endpoints are given precedence in proxies by default. The default value of num is 0, meaning that insecure endpoints are given preference.

Setting this property to a non-0 value is the equivalent of invoking the proxy method ice_preferSecure(true) on proxies created by the Ice run time, such as those returned by stringToProxy or received as the result of an invocation. Proxies created by methods such as ice_oneway inherit the setting of the original proxy. If you want to force all proxies to use only secure endpoints, use Ice.Override.Secure instead.

See Configuring Secure Proxies for a discussion of secure proxies.

Ice.Default.Protocol

Synopsis

Ice.Default.Protocol=transport protocol

Description

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

Ice.Default.Router

Synopsis

Ice.Default.Router=router

Description

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 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

Synopsis

Ice.Default.SlicedFormat=num

Description

Specifies the encoding format of Slice classes and exceptions. The default value of num is 0, meaning that the encoding uses the compact format. Set this property to a non-0 value to use the sliced format by default. This setting is only relevant when using 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

Synopsis

Ice.Default.SourceAddress=addr

Description

If specified, outgoing socket connections will be bound using the given address addr. This allows to set a specific IP address as the source address of IP packets but it doesn't necessarily imply that the operating system will use the network interface matching this IP address to send out the IP packet. It must be set to a numeric IP address. Proxy endpoints can override this setting with the --sourceAddress option. If no source address is configured, the Ice run time uses the operating system's default behavior for binding an outgoing socket connection.

This feature is not supported on WinRT.

Ice.Default.Timeout

Synopsis

Ice.Default.Timeout=num

Description

Specifies the default timeout in milliseconds to use for an endpoint if no timeout is configured using the -t option. Use the value -1 to configure an infinite default timeout. If not defined, the default timeout is 60000.