moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-08-13 17:03:50 -04:00
Code Issues Releases Wiki Activity

curl_easy_upkeep: removed 'conn' from the name

Browse Source 
... including the associated option.

Fixes #2951
Closes #2952
This commit is contained in:
Daniel Stenberg 2018-09-07 10:28:57 +02:00
parent 7b655fcbad
commit 17ca0ccff4
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
13 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/libcurl/Makefile.inc
View File

@ -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

4
docs/libcurl/curl_easy_setopt.3
View File

@ -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

18
docs/libcurl/curl_easy_conn_upkeep.3 → docs/libcurl/curl_easy_upkeep.3
View File

@ -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. */

18
docs/libcurl/opts/CURLOPT_CONN_UPKEEP_INTERVAL_MS.3 → docs/libcurl/opts/CURLOPT_UPKEEP_INTERVAL_MS.3
View File

@ -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. */

2
docs/libcurl/opts/Makefile.inc
View File

@ -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 \

2
docs/libcurl/symbols-in-versions
View File

@ -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

2
include/curl/curl.h
View File

@ -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;

4
include/curl/easy.h
View File

@ -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
}

4
lib/easy.c
View File

@ -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 */

2
lib/setopt.c
View File

@ -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;

2
lib/url.c
View File

@ -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. */

2
lib/url.h
View File

@ -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

2
tests/data/test1135
View File

@ -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, ...);