Connection
The settings for controlling the connection to the HSM are detailed below.
| Variable | Quick Description |
|---|---|
HSM_MAX_SOCKET_RETRIES |
Maximum number of retries to open a TCP socket. |
HSM_CONNECT_TIMEOUT |
Waiting time (in milliseconds) for the connection to be established before it fails. |
HSM_MAX_CONNECT_RETRIES |
Maximum number of retries to connect to the HSM. |
HSM_RECV_TIMEOUT |
Waiting time (in milliseconds) for a network packet to be received before it fails. |
HSM_SEND_TIMEOUT |
Waiting time (in milliseconds) for a network packet transmission before it fails. |
Socket Opening Attempts
Environment variable to be defined: HSM_MAX_SOCKET_RETRIES
| Value | Socket Opening Attempts |
|---|---|
| Not defined | 03 attempts. |
| n | number of retries, minimum of 0 (zero) and maximum of 16 (sixteen). |
In some situations, the server running the application may have a very small number of local communication ports (known as sockets), which prevents or hinders communication between the application and the HSM.
Connection Timeout
Environment variable to be defined: HSM_CONNECT_TIMEOUT
| Value | Connection Timeout |
|---|---|
| Not defined (or 0) | uses the operating system's default timeout and a blocked socket. |
| n | time in milliseconds (ms) that the library must wait before giving up on closing the connection. |
Note: available from version 4.7.18 of the library.
Attempts to connect to the HSM
Environment variable to be defined: HSM_MAX_CONNECT_RETRIES
| Value | Attempts to connect to the HSM |
|---|---|
| Not defined | 03 attempts. |
| n | number of retries, minimum of 0 (zero) and maximum of 16 (sixteen). |
Reception Timeout
Environment variable to be defined: HSM_RECV_TIMEOUT
| Value | Reception Timeout |
|---|---|
| Not defined | default time used in the operating system's TCP/IP protocol stack. Consult the documentation for your particular operating system about this value. |
| n | time in milliseconds (ms) that the library must wait before it stops receiving data. |
Shipping Timeout
Environment variable to be defined: HSM_SEND_TIMEOUT
| Value | Shipping Timeout |
|---|---|
| Not defined | default time used in the operating system's TCP/IP protocol stack. Consult the documentation for your particular operating system about this value. |
| n | time in milliseconds (ms) that the library must wait before giving up receiving data/ |