diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2018-09-07 10:28:57 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2018-09-07 13:43:26 +0200 |
| commit | 17ca0ccff4aeacc63bf7fa90314ea58d23464617 (patch) | |
| tree | abcf11fd55789ba4fe8b720b362a231d2b4be437 /docs/libcurl/opts | |
| parent | 7b655fcbadffc3a0297466f1527e05d4a8efe6b2 (diff) | |
curl_easy_upkeep: removed 'conn' from the name
... including the associated option.
Fixes #2951
Closes #2952
Diffstat (limited to 'docs/libcurl/opts')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_UPKEEP_INTERVAL_MS.3 (renamed from docs/libcurl/opts/CURLOPT_CONN_UPKEEP_INTERVAL_MS.3) | 18 | ||||
| -rw-r--r-- | docs/libcurl/opts/Makefile.inc | 2 |
2 files changed, 10 insertions, 10 deletions
diff --git a/docs/libcurl/opts/CURLOPT_CONN_UPKEEP_INTERVAL_MS.3 b/docs/libcurl/opts/CURLOPT_UPKEEP_INTERVAL_MS.3 index e2545a5c8..91eea1ba6 100644 --- a/docs/libcurl/opts/CURLOPT_CONN_UPKEEP_INTERVAL_MS.3 +++ b/docs/libcurl/opts/CURLOPT_UPKEEP_INTERVAL_MS.3 @@ -20,24 +20,24 @@ .\" * .\" ************************************************************************** .\" -.TH CURLOPT_CONN_UPKEEP_INTERVAL_MS 3 "31 Oct 2018" "libcurl 7.62.0" "curl_easy_setopt options" +.TH CURLOPT_UPKEEP_INTERVAL_MS 3 "31 Oct 2018" "libcurl 7.62.0" "curl_easy_setopt options" .SH NAME -CURLOPT_CONN_UPKEEP_INTERVAL_MS \- connection upkeep interval +CURLOPT_UPKEEP_INTERVAL_MS \- connection upkeep interval .SH SYNOPSIS #include <curl/curl.h> -CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONN_UPKEEP_INTERVAL_MS, long upkeep_interval_ms); +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UPKEEP_INTERVAL_MS, long upkeep_interval_ms); .SH DESCRIPTION Some protocols have "connection upkeep" mechanisms. These mechanisms usually send some traffic on existing connections in order to keep them alive; this can prevent connections from being closed due to overzealous firewalls, for example. -The user needs to explicitly call \fIcurl_easy_conn_upkeep(3)\fP in order to +The user needs to explicitly call \fIcurl_easy_upkeep(3)\fP in order to perform the upkeep work. Currently the only protocol with a connection upkeep mechanism is HTTP/2: when -the connection upkeep interval is exceeded and \fIcurl_easy_conn_upkeep(3)\fP +the connection upkeep interval is exceeded and \fIcurl_easy_upkeep(3)\fP is called, an HTTP/2 PING frame is sent on the connection. .SH DEFAULT @@ -50,16 +50,16 @@ if(curl) { curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); /* Set the interval to 30000ms / 30s */ - curl_easy_setopt(curl, CURLOPT_CONN_UPKEEP_INTERVAL_MS, 30000L); + curl_easy_setopt(curl, CURLOPT_UPKEEP_INTERVAL_MS, 30000L); curl_easy_perform(curl); /* Perform more work here. */ - /* While the connection is being held open, curl_easy_conn_upkeep() can be - called. If curl_easy_conn_upkeep() is called and the time since the last + /* While the connection is being held open, curl_easy_upkeep() can be + called. If curl_easy_upkeep() is called and the time since the last upkeep exceeds the interval, then an HTTP/2 PING is sent. */ - curl_easy_conn_upkeep(curl); + curl_easy_upkeep(curl); /* Perform more work here. */ diff --git a/docs/libcurl/opts/Makefile.inc b/docs/libcurl/opts/Makefile.inc index 869f9812e..117842dc3 100644 --- a/docs/libcurl/opts/Makefile.inc +++ b/docs/libcurl/opts/Makefile.inc @@ -94,7 +94,7 @@ man_MANS = \ CURLOPT_CHUNK_END_FUNCTION.3 \ CURLOPT_CLOSESOCKETDATA.3 \ CURLOPT_CLOSESOCKETFUNCTION.3 \ - CURLOPT_CONN_UPKEEP_INTERVAL_MS.3 \ + CURLOPT_UPKEEP_INTERVAL_MS.3 \ CURLOPT_CONNECTTIMEOUT.3 \ CURLOPT_CONNECTTIMEOUT_MS.3 \ CURLOPT_CONNECT_ONLY.3 \ |