xref: /aosp_15_r20/external/curl/docs/cmdline-opts/keepalive-time.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerLong: keepalive-time
5*6236dae4SAndroid Build Coastguard WorkerArg: <seconds>
6*6236dae4SAndroid Build Coastguard WorkerHelp: Interval time for keepalive probes
7*6236dae4SAndroid Build Coastguard WorkerAdded: 7.18.0
8*6236dae4SAndroid Build Coastguard WorkerCategory: connection timeout
9*6236dae4SAndroid Build Coastguard WorkerMulti: single
10*6236dae4SAndroid Build Coastguard WorkerSee-also:
11*6236dae4SAndroid Build Coastguard Worker  - no-keepalive
12*6236dae4SAndroid Build Coastguard Worker  - keepalive-cnt
13*6236dae4SAndroid Build Coastguard Worker  - max-time
14*6236dae4SAndroid Build Coastguard WorkerExample:
15*6236dae4SAndroid Build Coastguard Worker  - --keepalive-time 20 $URL
16*6236dae4SAndroid Build Coastguard Worker---
17*6236dae4SAndroid Build Coastguard Worker
18*6236dae4SAndroid Build Coastguard Worker# `--keepalive-time`
19*6236dae4SAndroid Build Coastguard Worker
20*6236dae4SAndroid Build Coastguard WorkerSet the time a connection needs to remain idle before sending keepalive probes
21*6236dae4SAndroid Build Coastguard Workerand the time between individual keepalive probes. It is currently effective on
22*6236dae4SAndroid Build Coastguard Workeroperating systems offering the `TCP_KEEPIDLE` and `TCP_KEEPINTVL` socket
23*6236dae4SAndroid Build Coastguard Workeroptions (meaning Linux, *BSD/macOS, Windows, Solaris, and recent AIX, HP-UX and more).
24*6236dae4SAndroid Build Coastguard WorkerKeepalive is used by the TCP stack to detect broken networks on idle connections.
25*6236dae4SAndroid Build Coastguard WorkerThe number of missed keepalive probes before declaring the connection down is OS
26*6236dae4SAndroid Build Coastguard Workerdependent and is commonly 8 (*BSD/macOS/AIX), 9 (Linux/AIX) or 5/10 (Windows), and
27*6236dae4SAndroid Build Coastguard Workerthis number can be changed by specifying the curl option `keepalive-cnt`.
28*6236dae4SAndroid Build Coastguard WorkerNote that this option has no effect if --no-keepalive is used.
29*6236dae4SAndroid Build Coastguard Worker
30*6236dae4SAndroid Build Coastguard WorkerIf unspecified, the option defaults to 60 seconds.
31