Table of Contents Previous Next
Logo
Properties : C.11 Ice Miscellaneous Properties
Copyright © 2003-2008 ZeroC, Inc.

C.11 Ice Miscellaneous Properties

Ice.ACM.Client

Synopsis

Ice.ACM.Client=num

Description

If num is set to a value larger than zero, client-side Active Connection Management (ACM) is enabled. This means that connections are automatically closed by the client after they have been idle for num seconds. This is transparent to applications because connections closed by ACM are automatically reestablished if they are needed again. The default value is 60, meaning that idle connections are automatically closed after one minute.

Ice.ACM.Server

Synopsis

Ice.ACM.Server=num

Description

This property is the server-side equivalent of Ice.ACM.Client. If num is set to a value larger than zero, server-side Active Connection Management (ACM) is enabled, in which the server automatically closes an incoming connection after it has been idle for num seconds. The default value is 0, meaning that server-side ACM is disabled by default.
Server-side ACM can cause incoming oneway requests to be silently discarded. See the Ice manual for more information.

Ice.BatchAutoFlush

Synopsis

Ice.BatchAutoFlush=num

Description

This property controls how the Ice run time deals with flushing of batch messages. If num is set to a non-zero value (the default), the run time 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 Ice.MessageSizeMax. If num is set to zero, batches must be flushed explicitly by the application; in this case, if the application adds more messages to a batch than permitted by Ice.MessageSizeMax, the application receives a MemoryLimitException when it flushes the batch.

Ice.CacheMessageBuffers

Synopsis

Ice.CacheMessageBuffers=num (Java, C#)

Description

If num is a value greater than zero, the Ice run time caches message buffers for future reuse. This can improve performance and reduce the amount of garbage produced by Ice internals that the garbage collector would eventually spend time to reclaim. However, for applications that exchange very large messages, this cache may consume excessive amounts of memory and therefore should be disabled by setting this property to zero. If not defined, the default value is 1.

Ice.ChangeUser

Synopsis

Ice.ChangeUser=user

Description

If set, Ice changes the user and group id to the respective ids of user in /etc/passwd. This only works if the Ice application is executed by the super-user (Unix only).

Ice.Compression.Level

Synopsis

Ice.Compression.Level=num

Description

Specifies the bzip2 compression level. Legal values for num are 1 to 9, where 1 represents the fastest compression and 9 represents the best compression. Note that higher levels cause the bzip2 algorithm to devote more resources to the compression effort, and may not result in a significant improvement over lower levels. If not specified, the default value is 1.

Ice.EventLog.Source

Synopsis

Ice.EventLog.Source=name

Description

Specifies the name of an event log source to be used by a Windows service that subclasses Ice::Service (see Section 8.3.2). The value of name represents a subkey of the Eventlog registry key. An application (or administrator) typically prepares the registry key when the service is installed. If no matching registry key is found, Windows logs events in the Application log. Any backslashes in name are silently converted to forward slashes. If not defined, Ice::Service uses the service name as specified by the --service option.

Ice.GC.Interval

Synopsis

Ice.GC.Interval=num

Description

This property determines the frequency with which the class garbage collector runs. If the interval is set to zero (the default), no collector thread is created. Otherwise, the collector thread runs every num seconds.

Ice.ImplicitContext

Synopsis

Ice.ImplicitContext=type

Description

Specifies whether a communicator has an implicit 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. See Section 28.11.4 for more information on implicit contexts.

Ice.MessageSizeMax

Synopsis

Ice.MessageSizeMax=num

Description

This property controls the maximum size (in kilobytes) of an uncompressed protocol message that is accepted or sent by the Ice run time. The size includes the size of the Ice protocol header. The default size is 1024 (1 Megabyte). Settings with a value less than 1 are ignored.
If a client sends a message that exceeds the client’s Ice.MessageSizeMax, or the server returns a reply that exceeds the client’s Ice.MessageSizeMax, the client receives a MemoryLimitException.
If a client sends a message that exceeds the server’s Ice.MessageSizeMax, the server immediately closes its connection, so the client receives a ConnectionLostException in that case. In addition, the server logs a MemoryLimitException if Ice.Warn.Connections is set.
If the server returns a reply that exceeds the server’s Ice.MessageSizeMax, the server logs a MemoryLimitException (if Ice.Warn.Connections is set) but does not close its connection to the client. The client receives an UnknownLocalException in this case.

Ice.Nohup

Synopsis

Ice.Nohup=num

Description

If num is set to a value larger than zero, the C++ classes Ice::Application and Ice::Service ignore SIGHUP (for Unix) and CTRL_LOGOFF_EVENT (for Windows). As a result, an application that sets Ice.Nohup continues to run if the user that started the application logs off. The default value for Ice::Application is 0, and the default value for Ice::Service is 1 (C++ only.)

Ice.NullHandleAbort

Synopsis

Ice.NullHandleAbort=num

Description

If num is set to a value larger than zero, invoking an operation using a null smart pointer causes the program to abort immediately instead of raising IceUtil::NullHandleException (C++ only).

Ice.Package.module

Synopsis

Ice.Package.module=package

Description

Associates a top-level Slice module with a Java package. If global metadata is used to enclose generated Java classes in a user-defined package, the Ice run time must be configured in order to successfully unmarshal exceptions and concrete class types. If all top-level modules are generated into the same user-defined package, it is easier to use Ice.Default.Package instead.

Ice.PrintAdapterReady

Synopsis

Ice.PrintAdapterReady=num

Description

If num is set to a value larger than zero, an object adapter prints "adapter_name ready" on standard output after initialization is complete. This is useful for scripts that need to wait until an object adapter is ready to be used.

Ice.PrintProcessId

Synopsis

Ice.PrintProcessId=num

Description

If num is set to a value larger than zero, the process ID is printed on standard output upon startup.

Ice.ProgramName

Synopsis

Ice.ProgramName=name

Description

name is the program name, which 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.) For all languages, 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 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) is to retry 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 zero, Ice automatically calls Communicator::shutdown once the communicator has been idle for num seconds. This shuts down the Communicator's server side and causes all threads waiting in Communicator::waitForShutdown to return. After that, a server will typically do some clean‑up work before exiting. The default value is zero, meaning that the server will not shut down automatically.

Ice.StdErr

Synopsis

Ice.StdErr=filename

Description

If filename is not empty, the standard error stream of this process is redirected to this file, in append mode. This property is checked only for the first communicator that is created in a process.

Ice.StdOut

Synopsis

Ice.StdOut=filename

Description

If filename is not empty, the standard output stream of this process is redirected to this file, in append mode. This property is checked only for the first communicator created in a process.

Ice.UseSyslog

Synopsis

Ice.UseSyslog=num

Description

If num is set to a value larger than zero, a special logger is installed that logs to the syslog facility instead of standard error. The identifier for syslog is the value of Ice.ProgramName (Unix only).
Table of Contents Previous Next
Logo