On this page:

Ice.ACM.Close

Synopsis

Ice.ACM.Close=num

Description

This property determines when Active Connection Management (ACM) closes a connection. Legal values for num correspond directly to the ACMClose enumerators found in Connection.ice:

Slice

local enum ACMClose
{
    CloseOff,
    CloseOnIdle,
    CloseOnInvocation,
    CloseOnInvocationAndIdle,
    CloseOnIdleForceful
}

The table below describes the semantics of each value:

Enumerator	Property Value	Description
`CloseOff`	0	ACM does not close the connection. A connection is closed when the communicator is destroyed, when there's a network failure or when the peer closes it.
`CloseOnIdle`	1	ACM closes the connection gracefully when this connection remains idle for `Timeout` (or longer) and has no outstanding invocation or dispatch.
`CloseOnInvocation`	2	ACM closes the connection forcefully when this connection remains idle for `Timeout` (or longer), has no outstanding dispatch and has at least one outstanding invocation. This setting is useful when you don't want ACM to close unused connections but still want ACM to close forcefully a connection when invocations are in progress but no messages are received from the peer, potentially indicating that the peer is dead. This setting should be used with a Heartbeat configuration where heartbeats are sent at regular intervals by the peer while a request is being dispatched (such as `HeartbeatOnDispatch`, `HeartbeatOnIdle` or `HeartbeatAlways`). Hearbeats prevent a connection from remaining idle; not receiving heartbeats from the peer indicates a problem with the peer or the connection.
`CloseOnInvocationAndIdle`	3	Combines the behaviors of `CloseOnIdle` and `CloseOnInvocation.` ACM closes a connection gracefully if it remains idle for `Timeout` (or longer) and has no outstanding invocation and dispatch (`CloseOnIdle`). ACM closes a connection forcefully if it remains idle for `Timeout` (or longer) and has one or more outstanding invocation but no outstanding dispatch (`CloseOnInvocation`).
`CloseOnIdleForceful`	4	ACM closes a connection when it remains idle for `Timeout` (or longer), regardless of pending invocations and dispatches.

You must set a non-zero value for Ice.ACM.Timeout for this property to have any effect. Use Ice.ACM.Close in conjunction with Ice.ACM.Heartbeat to tailor a connection management policy for your application. Use the corresponding Ice.ACM.Client.Close or Ice.ACM.Server.Close properties to override this setting in a client or server context, respectively. See Connection Closure for more information on closing connections.

If not defined, the default value is 3 for a client connection and 2 for a server connection.

Back to Top ^

Ice.ACM.Heartbeat

Synopsis

Ice.ACM.Heartbeat=num

Description

This property determines whether heartbeats are enabled. You can use heartbeats in conjunction with the Ice.ACM.Close and Ice.ACM.Timeout properties to create a connection management policy as part of Active Connection Management (ACM). Legal values for num correspond directly to the ACMHeartbeat enumerators found in Connection.ice:

Slice

local enum ACMHeartbeat
{
    HeartbeatOff,
    HeartbeatOnDispatch,
    HeartbeatOnIdle,
    HeartbeatAlways
}

The table below describes the semantics of each value:

Enumerator	Property Value	Description
`HeartbeatOff`	0	Disable heartbeats.
`HeartbeatOnDispatch`	1	When there is a pending dispatch and no data is sent or received over the connection, send heartbeats at regular intervals to prevent the connection from remaining idle. This is useful if you don't want to send heartbeats to keep the connection alive but still want ACM to notify the peer that the connection is alive while a dispatch is in progress.
`HeartbeatOnIdle`	2	When no data is sent or received over the connection, send heartbeats at regular intervals to prevent the connection from remaining idle. For example, if the application steadily reads data from a connection, the connection is not at risk from remaining idle and ACM does not send any heartbeat.
`HeartbeatAlways`	3	Send heartbeats at regular intervals until the connection is closed. Messages sent or received by the application on this connection don't cancel these heartbeats.

You must set a non-zero value for Ice.ACM.Timeout for this property to have any effect. Use the corresponding Ice.ACM.Client.Heartbeat or Ice.ACM.Server.Heartbeat properties to override this setting in a client or server context, respectively.

To send a heartbeat, ACM sends a validate connection message to the remote end. Heartbeats are not supported on datagram connections.

If not defined, the default value is 1.

Back to Top ^

Ice.ACM.Timeout

Synopsis

Ice.ACM.Timeout=num

Description

Description

Overrides the value of Ice.ACM.Timeout for server connections.

Back to Top ^