Skip to main content
Previous sectionNext section

TCPKeepAlive

Set the number of seconds between keep-alive messages.

Synopsis

[SQL]    TCPKeepAlive=n

n is an integer in the range 30—432,000. The default value is 300.

Description

TCPKeepAlive is the number of seconds between keep-alive messages. The setting applies only to InterSystems IRIS® data platform running on Windows and Linux. The default is 300 seconds (5 minutes), and the maximum value is 432,000 (5 days). If the value is 0, the instance uses the operating system default.

For further details, refer to the TCP Client/Server Communication chapter in I/O Device Guide.

Changing This Parameter

On the SQL page of the Management Portal (System Administration > Configuration > SQL and Object Settings > SQL), enter a value for the TCP keepalive for client connections (seconds) setting.

To set the desired value for PARAMETER from the InterSystems Terminal, use the SetTCPKeepAlive() method of the %SYSTEM.SQL class. See the class reference for details.

You can also change PARAMETER with the Config.SQL class (as described in the class reference) or by editing the CPF in a text editor (as described in the Editing the Active CPF section of the “Introduction to the Configuration Parameter File” chapter in this book).

For a TCP device, you can also specify this interval with the OPEN or USE commands, as the eighth parameter (for example: O tcp:("SERVER":port:mode:::::keepalive). or the keyword /KEEPALIVE=n. The OPEN command parameters for a TCP device are: hostname{:port{:mode{:terminators{:ibfsz{:obfsz{:queuesize{:keepalivetime}}}}}}}. For details about the OPEN and USE commands and arguments, including examples, see the ObjectScript Reference.