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 | |
parent | 7b655fcbadffc3a0297466f1527e05d4a8efe6b2 (diff) |
curl_easy_upkeep: removed 'conn' from the name
... including the associated option.
Fixes #2951
Closes #2952
Diffstat (limited to 'docs/libcurl')
-rw-r--r-- | docs/libcurl/Makefile.inc | 2 | ||||
-rw-r--r-- | docs/libcurl/curl_easy_setopt.3 | 4 | ||||
-rw-r--r-- | docs/libcurl/curl_easy_upkeep.3 (renamed from docs/libcurl/curl_easy_conn_upkeep.3) | 18 | ||||
-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 | ||||
-rw-r--r-- | docs/libcurl/symbols-in-versions | 2 |
6 files changed, 23 insertions, 23 deletions
diff --git a/docs/libcurl/Makefile.inc b/docs/libcurl/Makefile.inc index bcc0ed64b..f41bbe098 100644 --- a/docs/libcurl/Makefile.inc +++ b/docs/libcurl/Makefile.inc @@ -22,4 +22,4 @@ man_MANS = curl_easy_cleanup.3 curl_easy_getinfo.3 curl_easy_init.3 \ curl_mime_data.3 curl_mime_data_cb.3 curl_mime_filedata.3 \ curl_mime_filename.3 curl_mime_subparts.3 \ curl_mime_type.3 curl_mime_headers.3 curl_mime_encoder.3 libcurl-env.3 \ - libcurl-security.3 curl_easy_conn_upkeep.3 + libcurl-security.3 curl_easy_upkeep.3 diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3 index f33a34e34..bde52f999 100644 --- a/docs/libcurl/curl_easy_setopt.3 +++ b/docs/libcurl/curl_easy_setopt.3 @@ -480,9 +480,9 @@ Shuffle addresses before use. See \fICURLOPT_DNS_SHUFFLE_ADDRESSES(3)\fP Timeout for waiting for the server's connect back to be accepted. See \fICURLOPT_ACCEPTTIMEOUT_MS(3)\fP .IP CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS Timeout for happy eyeballs. See \fICURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS(3)\fP -.IP CURLOPT_CONN_UPKEEP_INTERVAL_MS +.IP CURLOPT_UPKEEP_INTERVAL_MS Sets the interval at which connection upkeep are performed. See -\fICURLOPT_CONN_UPKEEP_INTERVAL_MS(3)\fP +\fICURLOPT_UPKEEP_INTERVAL_MS(3)\fP .SH SSL and SECURITY OPTIONS .IP CURLOPT_SSLCERT Client cert. See \fICURLOPT_SSLCERT(3)\fP diff --git a/docs/libcurl/curl_easy_conn_upkeep.3 b/docs/libcurl/curl_easy_upkeep.3 index f95f0ab22..f705b61fb 100644 --- a/docs/libcurl/curl_easy_conn_upkeep.3 +++ b/docs/libcurl/curl_easy_upkeep.3 @@ -20,13 +20,13 @@ .\" * .\" ************************************************************************** .\" -.TH curl_easy_conn_upkeep 3 "31 Oct 2018" "libcurl 7.62.0" "libcurl Manual" +.TH curl_easy_upkeep 3 "31 Oct 2018" "libcurl 7.62.0" "libcurl Manual" .SH NAME -curl_easy_conn_upkeep - Perform any connection upkeep checks. +curl_easy_upkeep - Perform any connection upkeep checks. .SH SYNOPSIS .B #include <curl/curl.h> -.BI "CURLcode curl_easy_conn_upkeep(CURL *" handle ");" +.BI "CURLcode curl_easy_upkeep(CURL *" handle ");" .SH DESCRIPTION Some protocols have "connection upkeep" mechanisms. These mechanisms usually @@ -35,12 +35,12 @@ can prevent connections from being closed due to overzealous firewalls, for example. 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. This function must be explicitly called in order to perform the upkeep work. The connection upkeep interval is set with -\fICURLOPT_CONN_UPKEEP_INTERVAL_MS(3)\fP. +\fICURLOPT_UPKEEP_INTERVAL_MS(3)\fP. .SH AVAILABILITY Added in 7.62.0. @@ -57,16 +57,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/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 \ diff --git a/docs/libcurl/symbols-in-versions b/docs/libcurl/symbols-in-versions index d534e7164..2803a40d5 100644 --- a/docs/libcurl/symbols-in-versions +++ b/docs/libcurl/symbols-in-versions @@ -356,7 +356,7 @@ CURLOPT_CLOSEFUNCTION 7.7 7.11.1 7.15.5 CURLOPT_CLOSEPOLICY 7.7 7.16.1 CURLOPT_CLOSESOCKETDATA 7.21.7 CURLOPT_CLOSESOCKETFUNCTION 7.21.7 -CURLOPT_CONN_UPKEEP_INTERVAL_MS 7.62.0 +CURLOPT_UPKEEP_INTERVAL_MS 7.62.0 CURLOPT_CONNECTTIMEOUT 7.7 CURLOPT_CONNECTTIMEOUT_MS 7.16.2 CURLOPT_CONNECT_ONLY 7.15.2 |