TCP Keepalive
tcp.keepalive.enabled
Abbreviation | tc k e |
Access | get/set |
Description
Enable/disable TCP keepalive feature of network stack.
Note: These settings apply to ALL TCP connections (TCP client, TLS, TCP server)
Keepalive is a system for determining whether a connected peer is still connected. If the peer reboots or otherwise drops out without notice, keepalive detects the problem. It works by sending an empty message at a specified interval and receiving an ACK in reply from the peer. If the ACK is not received with an initial expiration period, the keepalive exchange is periodically retried at a specified retry period until the retry count is exceeded.
To determine the initial expiration period, see tcp.keepalive.initial_timeout.
To determine the retry period, see tcp.keepalive.retry_timeout.
To determine the maximum retry count, see tcp.keepalive.retry_count.
Arguments
<true/false>
Default
false
Properties
- takes effect immediately
- preserved by NVM Backup
Supported Platforms
Get example
> get tc k e
0
Set example
> set tc k e 1
Set OK
tcp.keepalive.initial_timeout
Abbreviation | tc k i |
Access | get/set |
Description
Number of seconds for initial keepalive expiration.
Arguments
<seconds>
Range: 1 - 65535
Default
60
Properties
- takes effect immediately
- preserved by NVM Backup
Supported Platforms
Get example
> get tc k i
60
Set example
> set tc k i 20
Set OK
tcp.keepalive.retry_count
Abbreviation | tc k c |
Access | get/set |
Description
Maximum number of times to retry keepalive. Once all retries are expired, close connection.
Arguments
<seconds>
Range: 1 - 255
Default
5
Properties
- takes effect immediately
- preserved by NVM Backup
Supported Platforms
Get example
> get tc k c
5
Set example
> set tc k c 10
Set OK
tcp.keepalive.retry_timeout
Abbreviation | tc k r |
Access | get/set |
Description
After initial expiration, period of retries in seconds.
Arguments
<seconds>
Range: 1 - 255
Default
5
Properties
- takes effect immediately
- preserved by NVM Backup
Supported Platforms
Get example
> get tc k r
5
Set example
> set tc k r 10
Set OK