Miscellaneous Ice.* Properties
Ice.BackgroundLocatorCacheUpdates
Synopsis
Ice.BackgroundLocatorCacheUpdates=num
Description
If num
is set to 0 (the default), an invocation on an indirect proxy whose endpoints are older than the configured locator cache timeout triggers a locator cache update; the run time delays the invocation until the new endpoints are returned by the locator.
If num
is set to a value larger than 0, an invocation on an indirect proxy with expired endpoints still triggers a locator cache update, but the update is performed in the background, and the run time uses the expired endpoints for the invocation. This avoids delaying the first invocation that follows expiry of a cache entry.
Ice.BatchAutoFlushSize
Synopsis
Ice.BatchAutoFlushSize=num
(in kilobytes)
Description
This property controls how the Ice runtime deals with flushing of batch messages. If num
is set to a value greater than 0, the runtime automatically forces a flush of the current batch when a new message is added to a batch and that message would cause the batch to exceed num
kilobytes. If num
is set to 0 or a negative number, batches must be flushed explicitly by the application. If not defined, the default value is 1024
.
When flushed, batch requests are sent as a single Ice message. The Ice runtime in the receiver limits incoming messages to the maximum size specified by Ice.MessageSizeMax, therefore the sender must periodically flush batch requests (whether manually or automatically) to ensure they do not exceed the receiver's configured limit.
Ice.ClassGraphDepthMax
Synopsis
Ice.ClassGraphDepthMax=num
Description
Specifies the maximum depth for a graph of Slice class instances to unmarshal. If this maximum is reached, the Ice runtime throws a MarshalException
. Reading and destroying a Slice class graph are recursive operations. This property prevents stack overflows from occurring if a sender sends a very large graph and not enough space on the stack is available. To read larger graphs, you can increase the value of this property. If not specified, the default value is 10.
Setting this property to 0 (or to a negative number) disables the depth limit altogether.
Ice.ImplicitContext
Synopsis
Ice.ImplicitContext=type
Description
Specifies whether a communicator has an implicit request context and, if so, at what scope the context applies. Legal values for this property are None
(equivalent to the empty string), PerThread
, and Shared
. If not specified, the default value is None
.
Ice.LogFile
Synopsis
Ice.LogFile=file
Description
Replaces the communicator's default logger with a simple file-based logger implementation. This property does not affect the per-process logger. The logger creates the specified file if necessary, otherwise it appends to the file. If the logger is unable to open the file, the application receives an InitializationException
during communicator initialization. If a logger object is supplied in the InitializationData
argument during communicator initialization, it takes precedence over this property.
Ice.MessageSizeMax
Synopsis
Ice.MessageSizeMax=num
(in kilobytes)
Description
This property controls the maximum size (in kilobytes) of an uncompressed protocol message that is accepted by the Ice runtime. The size includes the size of the Ice protocol header. The default size is 1024
(1
megabyte).
The only purpose of this property is to prevent a malicious or defective sender from triggering a large memory allocation in a receiver. If this is not a concern, you can set Ice.MessageSizeMax
to 0; setting this property to 0 (or to a negative number) disables the message size limit altogether.
If the Ice runtime in a receiver encounters an incoming message whose size exceeds the receiver's setting for Ice.MessageSizeMax
, the runtime throws a MemoryLimitException
and closes the connection. For example, when a client receives an oversized reply message, the result of its invocation is a MemoryLimitException
. When a server receives an oversized request message, the client receives a ConnectionLostException
(because the server closed the connection) and the server logs a message if Ice.Warn.Connections is set.
Ice.Nohup
Synopsis
Ice.Nohup=num
Description
If num
is set to a value larger than 0, the Ice::Service
C++ class ignores SIGHUP
on Unix and CTRL_LOGOFF_EVENT
on Windows. As a result, a server/service that sets Ice.Nohup
continues to run if the user that started the server/service logs off. The default value of this property is 1.
IceGrid, IceBox (IceStorm), and Glacier2 are implemented using Ice::Service
.
Ice.PrintAdapterReady
Synopsis
Ice.PrintAdapterReady=num
Description
If num
is set to a value larger than 0, an object adapter prints "adapter_name ready" on standard output after activation is complete. This is useful for scripts that need to wait until an object adapter is ready to be used.
Ice.ProgramName
Synopsis
Ice.ProgramName=name
Description
name
is the program name, which is used for logging. This name is set automatically from argv[0]
(C++) and from AppDomain.CurrentDomain.FriendlyName
(C#) during initialization. For Java, Ice.ProgramName
is initialized to the empty string. The default name can be overridden by setting this property.
Ice.RetryIntervals
Synopsis
Ice.RetryIntervals=num [num ...]
Description
This property defines the number of times an operation is automatically retried and the delay between each retry. For example, if the property is set to 0 100 500
, the operation is retried 3 times: immediately after the first failure, again after waiting 100ms after the second failure, and again after waiting 500ms after the third failure. The default value (0
) means Ice retries once immediately. If set to -1
, no retry occurs.
Ice.ServerIdleTime
Synopsis
Ice.ServerIdleTime=num
Description
If num
is set to a value larger than 0, Ice automatically calls shutdown
on the communicator when its server thread pool has been idle for num
seconds. The server thread pool is not idle as long as any of its thread is performing some task, like dispatching a request.
This call to shutdown
shuts down the communicator's server side and causes any thread waiting on waitForShutdown
to return. After that, a server will typically do some clean-up work before exiting. The default value is 0, meaning that the server will not shut down automatically. This property is often used for servers that are automatically activated by IceGrid.
For C# applications and Windows C++ applications, the server idle time takes effect only once all the server thread pool idle threads have been reaped (the thread idle time can be configured with the ThreadIdleTime thread pool property.
Ice.ToStringMode
Synopsis
Ice.ToStringMode=string
Description
string
must be one of the following: Unicode
, ASCII
, Compat
.
This property maps to an enumerator of ToStringMode and controls how identityToString
and proxyToString
on the communicator escape non-printable ASCII characters and non-ASCII characters.
The default value is Unicode
.