summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2018-09-07 10:28:57 +0200
committerDaniel Stenberg <daniel@haxx.se>2018-09-07 10:28:57 +0200
commita01a5323e31b8aeabad0f45e1d3403c49887e833 (patch)
tree09ea90b4dc71073a07b2ce452886bad69b9ca1c7
parent7b655fcbadffc3a0297466f1527e05d4a8efe6b2 (diff)
downloadcurl-a01a5323e31b8aeabad0f45e1d3403c49887e833.tar.gz
curl_easy_upkeep: removed 'conn' from the name
... including the associated option. Fixes #2951
-rw-r--r--docs/libcurl/Makefile.inc2
-rw-r--r--docs/libcurl/curl_easy_setopt.34
-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)8
-rw-r--r--docs/libcurl/opts/Makefile.inc2
-rw-r--r--docs/libcurl/symbols-in-versions2
-rw-r--r--include/curl/curl.h2
-rw-r--r--include/curl/easy.h4
-rw-r--r--lib/easy.c4
-rw-r--r--lib/setopt.c2
-rw-r--r--lib/url.c2
-rw-r--r--lib/url.h2
-rw-r--r--tests/data/test11352
13 files changed, 27 insertions, 27 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..bed24a870 100644
--- a/docs/libcurl/opts/CURLOPT_CONN_UPKEEP_INTERVAL_MS.3
+++ b/docs/libcurl/opts/CURLOPT_UPKEEP_INTERVAL_MS.3
@@ -20,13 +20,13 @@
.\" *
.\" **************************************************************************
.\"
-.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
@@ -50,7 +50,7 @@ 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);
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
diff --git a/include/curl/curl.h b/include/curl/curl.h
index 8aac52a2a..999fd963a 100644
--- a/include/curl/curl.h
+++ b/include/curl/curl.h
@@ -1869,7 +1869,7 @@ typedef enum {
CINIT(UPLOAD_BUFFERSIZE, LONG, 280),
/* Time in ms between connection upkeep calls for long-lived connections. */
- CINIT(CONN_UPKEEP_INTERVAL_MS, LONG, 281),
+ CINIT(UPKEEP_INTERVAL_MS, LONG, 281),
CURLOPT_LASTENTRY /* the last unused */
} CURLoption;
diff --git a/include/curl/easy.h b/include/curl/easy.h
index 4328e9fdd..f42a8a969 100644
--- a/include/curl/easy.h
+++ b/include/curl/easy.h
@@ -97,13 +97,13 @@ CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer,
/*
- * NAME curl_easy_conn_upkeep()
+ * NAME curl_easy_upkeep()
*
* DESCRIPTION
*
* Performs connection upkeep for the given session handle.
*/
-CURL_EXTERN CURLcode curl_easy_conn_upkeep(CURL *curl);
+CURL_EXTERN CURLcode curl_easy_upkeep(CURL *curl);
#ifdef __cplusplus
}
diff --git a/lib/easy.c b/lib/easy.c
index 83433f1f5..88fc4f460 100644
--- a/lib/easy.c
+++ b/lib/easy.c
@@ -1201,7 +1201,7 @@ CURLcode curl_easy_send(struct Curl_easy *data, const void *buffer,
/*
* Performs connection upkeep for the given session handle.
*/
-CURLcode curl_easy_conn_upkeep(struct Curl_easy *data)
+CURLcode curl_easy_upkeep(struct Curl_easy *data)
{
/* Verify that we got an easy handle we can work with. */
if(!GOOD_EASY_HANDLE(data))
@@ -1209,7 +1209,7 @@ CURLcode curl_easy_conn_upkeep(struct Curl_easy *data)
if(data->multi_easy) {
/* Use the common function to keep connections alive. */
- return Curl_conn_upkeep(&data->multi_easy->conn_cache, data);
+ return Curl_upkeep(&data->multi_easy->conn_cache, data);
}
else {
/* No connections, so just return success */
diff --git a/lib/setopt.c b/lib/setopt.c
index 13c7da960..22956a20f 100644
--- a/lib/setopt.c
+++ b/lib/setopt.c
@@ -2624,7 +2624,7 @@ CURLcode Curl_vsetopt(struct Curl_easy *data, CURLoption option,
va_arg(param, char *));
data->set.doh = data->set.str[STRING_DOH]?TRUE:FALSE;
break;
- case CURLOPT_CONN_UPKEEP_INTERVAL_MS:
+ case CURLOPT_UPKEEP_INTERVAL_MS:
arg = va_arg(param, long);
if(arg < 0)
return CURLE_BAD_FUNCTION_ARGUMENT;
diff --git a/lib/url.c b/lib/url.c
index bd8e5d95e..977f1d6ad 100644
--- a/lib/url.c
+++ b/lib/url.c
@@ -4871,7 +4871,7 @@ static int conn_upkeep(struct connectdata *conn,
return 0; /* continue iteration */
}
-CURLcode Curl_conn_upkeep(struct conncache *conn_cache,
+CURLcode Curl_upkeep(struct conncache *conn_cache,
void *data)
{
/* Loop over every connection and make connection alive. */
diff --git a/lib/url.h b/lib/url.h
index 089613abd..3eb733a0a 100644
--- a/lib/url.h
+++ b/lib/url.h
@@ -77,7 +77,7 @@ int Curl_removeHandleFromPipeline(struct Curl_easy *handle,
void Curl_getoff_all_pipelines(struct Curl_easy *data,
struct connectdata *conn);
-CURLcode Curl_conn_upkeep(struct conncache *conn_cache, void *data);
+CURLcode Curl_upkeep(struct conncache *conn_cache, void *data);
#define CURL_DEFAULT_PROXY_PORT 1080 /* default proxy port unless specified */
#define CURL_DEFAULT_HTTPS_PROXY_PORT 443 /* default https proxy port unless
diff --git a/tests/data/test1135 b/tests/data/test1135
index 995cd25b9..3591a543b 100644
--- a/tests/data/test1135
+++ b/tests/data/test1135
@@ -75,7 +75,7 @@ CURL_EXTERN CURL *curl_easy_duphandle(CURL *curl);
CURL_EXTERN void curl_easy_reset(CURL *curl);
CURL_EXTERN CURLcode curl_easy_recv(CURL *curl, void *buffer, size_t buflen,
CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer,
-CURL_EXTERN CURLcode curl_easy_conn_upkeep(CURL *curl);
+CURL_EXTERN CURLcode curl_easy_upkeep(CURL *curl);
CURL_EXTERN int curl_mprintf(const char *format, ...);
CURL_EXTERN int curl_mfprintf(FILE *fd, const char *format, ...);
CURL_EXTERN int curl_msprintf(char *buffer, const char *format, ...);