Introduction

The CA API Gateway ("Gateway") will close a TCP connection if it has been open for a certain period without any data being received. This is considered a connection timeout. The Gateway will close inbound connections after 60 seconds of the initial connection if no packets are received. Connection timeouts may be exceeded if a client application opens a TCP connection before it is ready to write data to a socket or if an intermediary network device is blocking certain packets. If a packet is received within the connection timeout limit then this limit will no longer apply and a separate read timeout will be in effect.

It may be desirable to adjust the connection timeout to accommodate for certain behaviours (e.g. slow clients). This document describes the process of adjusting the inbound connection timeout limit for a Listen Port configured on the Gateway.

Solution

To increase the timeout period, please follow the instructions below.

1. Log in to Policy Manager as an administrative user.
2. In Policy Manager, select Tasks > Manage Listen Ports from the menu.
3. Select the desired port to be modified and click the Properties button.
4. Select the Advanced tab.
5. Create a new Advanced Property by clicking the Add button in the Advanced Properties section and filling in the information below:
   1. Property name: connectionTimeout
   2. Value: 720000
      • 720000 above is an example, any number (presented in milliseconds) can be used.
6. Click OK to save the changes.

Please note the following caveats:

• This change cannot be made to the port currently in use to connect to the CA API Gateway. The default port is 8443. Use an alternate port or create a new port if a second port is not available
• The value of the connectionTimeout advanced property should be an integer value in milliseconds.