Connection Configuration Parameters
| Parameters | Default | Description |
|---|---|---|
| Use_Persistent_Connections | yes | The Use_Persistent_Connections parameter enables the persistent connections functionality.Possible settings: — yes – Enables the feature. The client establishes persistent connections with the NAE servers. — no – Disables the feature. A new connection is made for each connection request. The connection is closed as soon as the client receives the server response. |
| Size_of_Connection_Pool | 300 | The Size_of_Connection_Pool parameter specifies the total number of client-server connections that the configuration could possibly allow. (Not what actually exists at a given moment.)Possible setting: — Any positive integer. Connections in the pool can be active or waiting, TCP or SSL. A connection is created as needed, and the pool scales as needed. The pool starts at size 0, and can grow to the value set here. Once the pool is full, new connection requests must wait for an existing connection to close. Connection pooling is configured on a per-client basis. The size of the pool applies to each client, it is not a total value for a Key Manager or for a load balancing group. If there are multiple clients running on the same machine, separate connection pools are maintained for each client. |
| Connection_Idle_Timeout | 600000ms (10 min) | The Connection_Idle_Timeout parameter specifies the amount of time connections in the connection pool can remain idle before the client closes them.Possible setting: —Any positive integer. Note: There are two different connection timeout values: one on the Key Manager, and one in the properties file. The value of the timeout in the properties file must be less than what is set on the server. This lets the client control when idle connections are closed. Otherwise, the client can maintain a connection that is closed on the server side, which can lead to error. |
| Unreachable_Server_Retry_Period | 60000ms | The Unreachable_Server_Retry_Period parameter specifies the amount of time the client will spend attempting to establish a connection to a load balancing group. An error is returned after the specified period if no server in the group is reachable. If logging is enabled, error messages are written to the log file.Possible settings —-1 – This is the infinite retry interval. The client keeps trying to connect to a server until a connection is established. This setting is not compatible with multi-tier load balancing because the load balancer will never switch tiers. —Any positive integer – If multi-tier load balancing is enabled then set this value between 1 and twice the value of the Connection_Retry_Interval. |
| Maximum_Server_Retry_Period | 0 | The Maximum_Server_Retry_Period parameter specifies the total amount of time that the client will spend trying to make connections to any server on any tier. This value is only used when multi-tiered load balancing is enabled.Possible settings —-1 – The connection manager will try every server on every tier until one answers. —0 – The default value is set to 0; there is no overall limit. Setting value to 0 disables this feature. —Any positive value – The connection manager will try to make connections for at least the duration set in Maximum_Server_Retry_Period and will return an error if no connection can be made on the tier in use when the try period expires. |
| Connection_Timeout | 1 minute | The Connection_Timeout parameter specifies how long the client waits for the TCP connect function before timing out.Possible setting —0 – Disables this setting. The client uses the operating system’s connect timeout. —Any positive integer Setting this parameter a few hundred ms less than the operating system’s connection timeout makes connection attempts to a downed server fail faster, and failover happens sooner. If a connection cannot be made before the timeout expires, the server is marked as down and taken out of the rotation. Note: If the client is working with many versions of a key, do not set the Connection_Timeout parameter too low. Otherwise the client connection may close before the operation is complete. |
| Connection_Read_Timeout | 7000ms | The Connection_Read_Timeout parameter controls how long the client waits when reading data from the Key Manager before determining that it is down. Requests should only time out if the Key Manager is physically down (e.g. powered off, or not responding because of misconfiguration).Possible settings &mdash0 – Disables this setting. The client waits indefinitely until the Key Manager can be reached. Requests remain outstanding until the client’s request is successfully satisfied. —Any positive integer. The purpose of this parameter is to control how the client should react when the Key Manager is down. If it should time out eventually and return an error back to the application, then set this parameter to an appropriate number of milliseconds to allow requests to complete in high load and high latency situations. |
| Connection_Retry_Interval | 60000ms (1 minute) | The Connection_Retry_Interval parameter determines how long the client waits before trying to reconnect to a disabled server. If one of the Key Managers in a load balanced configuration is not reachable, the client assumes that the server is down, and then waits for the specified time period before trying to connect to it again.Possible settings: —0 – This is the infinite retry interval. The disabled server will never be brought back into use. —Any positive integer. |
