mirror of
https://github.com/curl/curl.git
synced 2026-05-25 03:46:19 +03:00
e3fe020089
Remove the PROTOCOLS section from the source files completely and instead generate them based on the header data in the curldown files. It also generates TLS backend information for options marked for TLS as protocol. Closes #13175
68 lines
1.3 KiB
Markdown
68 lines
1.3 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_TCP_KEEPIDLE
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_TCP_KEEPALIVE (3)
|
|
- CURLOPT_TCP_KEEPINTVL (3)
|
|
Protocol:
|
|
- All
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_TCP_KEEPIDLE - TCP keep-alive idle time wait
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPIDLE, long delay);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a long. Sets the *delay*, in seconds, to wait while the connection is
|
|
idle before sending keepalive probes. Not all operating systems support this
|
|
option.
|
|
|
|
The maximum value this accepts is 2147483648. Any larger value is capped to
|
|
this amount.
|
|
|
|
# DEFAULT
|
|
|
|
60
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
/* enable TCP keep-alive for this transfer */
|
|
curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);
|
|
|
|
/* set keep-alive idle time to 120 seconds */
|
|
curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);
|
|
|
|
/* interval time between keep-alive probes: 60 seconds */
|
|
curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);
|
|
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.25.0
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|