Object Adapter Properties
adapter.AdapterId
Synopsis
adapter.AdapterId=id
Description
Assigns an adapter ID to this object adapter. An object adapter with an adapter ID is called an indirect adapter.
This ID must be unique among all object adapters using the same locator instance. If a locator proxy is defined using adapter.Locator or Ice.Default.Locator, this object adapter registers its endpoints with the locator registry upon activation.
adapter.Connection.CloseTimeout
Synopsis
adapter.Connection.CloseTimeout=num (in seconds)
Description
Overrides the setting of Ice.Connection.Server.CloseTimeout for this object adapter.
adapter.Connection.ConnectTimeout
Synopsis
adapter.Connection.ConnectTimeout=num (in seconds)
Description
Overrides the setting of Ice.Connection.Server.ConnectTimeout for this object adapter.
adapter.Connection.EnableIdleCheck
Synopsis
adapter.Connection.EnableIdleCheck=num
Description
Overrides the setting of Ice.Connection.Server.EnableIdleCheck for this object adapter.
adapter.Connection.IdleTimeout
Synopsis
adapter.Connection.IdleTimeout=num (in seconds)
Description
Overrides the setting of Ice.Connection.Server.IdleTimeout for this object adapter.
adapter.Connection.InactivityTimeout
Synopsis
adapter.Connection.InactivityTimeout=num (in seconds)
Description
Overrides the setting of Ice.Connection.Server.InactivityTimeout for this object adapter.
adapter.Connection.MaxDispatches
Synopsis
adapter.Connection.MaxDispatches=num
Description
Overrides the setting of Ice.Connection.Server.MaxDispatches for this object adapter.
adapter.Endpoints
Synopsis
adapter.Endpoints=endpoints
Description
Sets the physical endpoints of this object adapter. These endpoints correspond to the network interfaces on which the object adapter accepts connections and receives requests.
adapter.Locator
Synopsis
adapter.Locator=locator
Description
Specifies the locator of this object adapter. The value is a stringified proxy to an Ice::Locator object.
As a proxy property, you can configure additional aspects of the proxy using properties.
adapter.MaxConnections
Synopsis
adapter.MaxConnections=num
Description
When num is greater than 0, this object adapter accepts a maximum of num incoming connections. Once the limit is reached, an incoming connection must be closed before this object adapter accepts a new incoming connection.
The limit is infinite when num is 0 or less.
The default value for max connections is 0.
adapter.MessageSizeMax
Synopsis
adapter.MessageSizeMax=num
Description
Overrides the setting of Ice.MessageSizeMax to limit the size of messages that can be received by this object adapter. If not defined, the adapter uses the value of Ice.MessageSizeMax.
adapter.ProxyOptions
Synopsis
adapter.ProxyOptions=options
Description
Specifies the proxy options for proxies created by the object adapter. The value is a string representing the proxy options as they would be specified in a stringified proxy.
adapter.PublishedEndpoints
Synopsis
adapter.PublishedEndpoints=endpoints
Description
The published endpoints of an object adapter can be set using adapter.PublishedEndpoints. The exact algorithm is described in Published Object Adapter Endpoints.
adapter.PublishedHost
Synopsis
adapter.PublishedHost=host
Description
Specifies the published host for this object adapter. A published host is usually a DNS name, but it can also be an IP address.
The published host is used by the algorithm that computes the published endpoints of an object adapter, when adapter.PublishedEndpoints is not set. See Published Object Adapter Endpoints. This property is particularly useful when the object adapter endpoints do not specify port numbers.
adapter.ReplicaGroupId
Synopsis
adapter.ReplicaGroupId=id
Description
Identifies the group of replicated object adapters to which this adapter belongs. The replica group is treated as a virtual object adapter, so that an indirect proxy of the form identity@id refers to the object adapters in the group. During binding, a client will attempt to establish a connection to an endpoint of one of the participating object adapters, and automatically try others until a connection is successfully established or all attempts have failed. Similarly, an outstanding request will, when permitted, automatically fail over to another object adapter of the replica group upon connection failure. The set of endpoints actually used by the client during binding is determined by the locator's configuration policies.
Defining a value for this property has no effect unless adapter.AdapterId is also defined. Furthermore, the locator registry may require replica groups to be defined in advance (see IceGrid.Registry.DynamicRegistration), otherwise Ice.NotRegisteredException is thrown upon adapter activation. Regardless of whether an object adapter is replicated, it can always be addressed individually in an indirect proxy if it defines a value for adapter.AdapterId.
adapter.Router
Synopsis
adapter.Router=router
Description
Specifies a router for this object adapter. The value is a stringified proxy to an Ice::Router object. Defining a router allows the object adapter to receive callbacks from the router over a bidirectional connection, thereby avoiding the need for the router to establish a connection back to the object adapter.
A router can only be assigned to one object adapter. Specifying the same router for more than one object adapter results in undefined behavior. The default value is no router.
As a proxy property, you can configure additional aspects of the proxy using properties.
adapter.ThreadPool.Serialize
Synopsis
adapter.ThreadPool.Serialize=num
Description
If num is a value greater than 0, the adapter's thread pool serializes all messages from each connection. It is not necessary to enable this feature in a thread pool whose maximum size is 1 thread. When a thread pool dispatches requests implemented with AMD, it serializes the dispatching of requests from each connection, but it does not wait for a request to complete before it dispatches the next request.
In a multi-threaded pool, enabling serialization allows requests from different connections to be dispatched concurrently while preserving the order of messages on each connection. Note that serialization can have a significant impact on latency and throughput. If not defined, the default value is 0.
adapter.ThreadPool.Size
Synopsis
adapter.ThreadPool.Size=num
Description
A communicator creates a default server thread pool that dispatches requests to its object adapters. An object adapter can also be configured with its own thread pool. This is useful in avoiding deadlocks due to thread starvation by ensuring that a minimum number of threads is available for dispatching requests to certain Ice objects.
num is the initial number of threads in the thread pool. The default value is 0, meaning that an object adapter by default uses the communicator's server thread pool. See Ice.ThreadPool.name.Size for more information.
adapter.ThreadPool.SizeMax
Synopsis
adapter.ThreadPool.SizeMax=num
Description
num is the maximum number of threads for the thread pool. See Ice.ThreadPool.name.SizeMax for more information.
The default value is the value of adapter.ThreadPool.Size, meaning the thread pool can never grow larger than its initial size.
adapter.ThreadPool.SizeWarn
Synopsis
adapter.ThreadPool.SizeWarn=num
Description
Whenever num threads are active in a thread pool, a "low on threads" warning is printed. The default value is 0, which disables the warning.
adapter.ThreadPool.ThreadIdleTime
Synopsis
adapter.ThreadPool.ThreadIdleTime=num
Description
In a dynamically-sized thread pool, Ice reaps a thread after it is idle for num seconds. Setting this property to 0 disables idle thread reaping. If not specified, the default value is 60 seconds. See Ice.ThreadPool.name.ThreadIdleTime for more information.