curl_easy_upkeep: removed 'conn' from the name

... including the associated option.

Fixes #2951
Closes #2952

diff --git a/docs/libcurl/Makefile.inc b/docs/libcurl/Makefile.inc
index bcc0ed64b8d5a3b617f2e7e927c5b536d780f43a..f41bbe098db2cf40ffcb9e98487e255b3fb97983 100644 (file)
--- 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 f33a34e347d92d95b00e56c8b6f2bcb4f3811c0e..bde52f999101d5d0fe82f0af0bfa840747d23708 100644 (file)
--- 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
similarity index 79%
rename from docs/libcurl/curl_easy_conn_upkeep.3
rename to docs/libcurl/curl_easy_upkeep.3
index f95f0ab2263eff80cf0ee163d0eb53ab48b47426..f705b61fb28cceda72a07219490997c544c99c82 100644 (file)
--- 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
similarity index 76%
rename from docs/libcurl/opts/CURLOPT_CONN_UPKEEP_INTERVAL_MS.3
rename to docs/libcurl/opts/CURLOPT_UPKEEP_INTERVAL_MS.3
index e2545a5c8b3a630dd7e7e53883171e255d6bbee9..91eea1ba61de5763b8386b4ea0c30cdcaed84c8b 100644 (file)
--- 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 869f9812e5ed2eb9921e3dcd174a4baa995f1521..117842dc39aa53450c5e7fcef1a544a597d73ad9 100644 (file)
--- 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 d534e716498e7a33201192729845925e489868e2..2803a40d5de5144e1696a78f6c7ec47fc1b6590a 100644 (file)
--- 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 8aac52a2a27411cbdd4a874b4a74be93ef5fd3e7..999fd963a18a0738a93689f4e5e625cf1fa6b97a 100644 (file)
--- 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 4328e9fdd8aa883bbbef37e513e2cb97d90353b5..f42a8a96927972f3cf893f92b1252e7b6425d2bd 100644 (file)
--- 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 83433f1f59048983bf43899489b0e3f478aedfb2..88fc4f4601a3659b02c89277bc28e6d22a444e51 100644 (file)
--- 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 13c7da960eac74e5523833f695a288ae4848b38b..22956a20fbcfe328dc4e9357a9329b76fa59ae92 100644 (file)
--- 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 bd8e5d95e8a8d1dd9c06f898dcd0045c9268452a..977f1d6ad199be44f65c30138442f14adbf8975e 100644 (file)
--- 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 089613abdc8840de21de1df861c46ad2ae047a61..3eb733a0a219fc404e109eb54437d14e0c95182c 100644 (file)
--- 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 995cd25b9e8300c3cf7241bdfe12eeb06d193cfa..3591a543bb54ef3fd0f1dc6058eab611fe96c8d7 100644 (file)
--- 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, ...);