mirror of
https://github.com/moparisthebest/curl
synced 2024-11-14 21:45:13 -05:00
curl_easy_upkeep: removed 'conn' from the name
... including the associated option. Fixes #2951 Closes #2952
This commit is contained in:
parent
7b655fcbad
commit
17ca0ccff4
@ -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_data.3 curl_mime_data_cb.3 curl_mime_filedata.3 \
|
||||||
curl_mime_filename.3 curl_mime_subparts.3 \
|
curl_mime_filename.3 curl_mime_subparts.3 \
|
||||||
curl_mime_type.3 curl_mime_headers.3 curl_mime_encoder.3 libcurl-env.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
|
||||||
|
@ -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
|
Timeout for waiting for the server's connect back to be accepted. See \fICURLOPT_ACCEPTTIMEOUT_MS(3)\fP
|
||||||
.IP CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS
|
.IP CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS
|
||||||
Timeout for happy eyeballs. See \fICURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS(3)\fP
|
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
|
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
|
.SH SSL and SECURITY OPTIONS
|
||||||
.IP CURLOPT_SSLCERT
|
.IP CURLOPT_SSLCERT
|
||||||
Client cert. See \fICURLOPT_SSLCERT(3)\fP
|
Client cert. See \fICURLOPT_SSLCERT(3)\fP
|
||||||
|
@ -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
|
.SH NAME
|
||||||
curl_easy_conn_upkeep - Perform any connection upkeep checks.
|
curl_easy_upkeep - Perform any connection upkeep checks.
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B #include <curl/curl.h>
|
.B #include <curl/curl.h>
|
||||||
|
|
||||||
.BI "CURLcode curl_easy_conn_upkeep(CURL *" handle ");"
|
.BI "CURLcode curl_easy_upkeep(CURL *" handle ");"
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
|
|
||||||
Some protocols have "connection upkeep" mechanisms. These mechanisms usually
|
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.
|
example.
|
||||||
|
|
||||||
Currently the only protocol with a connection upkeep mechanism is HTTP/2: when
|
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.
|
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.
|
This function must be explicitly called in order to perform the upkeep work.
|
||||||
The connection upkeep interval is set with
|
The connection upkeep interval is set with
|
||||||
\fICURLOPT_CONN_UPKEEP_INTERVAL_MS(3)\fP.
|
\fICURLOPT_UPKEEP_INTERVAL_MS(3)\fP.
|
||||||
|
|
||||||
.SH AVAILABILITY
|
.SH AVAILABILITY
|
||||||
Added in 7.62.0.
|
Added in 7.62.0.
|
||||||
@ -57,16 +57,16 @@ if(curl) {
|
|||||||
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
||||||
|
|
||||||
/* Set the interval to 30000ms / 30s */
|
/* 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);
|
curl_easy_perform(curl);
|
||||||
|
|
||||||
/* Perform more work here. */
|
/* Perform more work here. */
|
||||||
|
|
||||||
/* While the connection is being held open, curl_easy_conn_upkeep() can be
|
/* While the connection is being held open, curl_easy_upkeep() can be
|
||||||
called. If curl_easy_conn_upkeep() is called and the time since the last
|
called. If curl_easy_upkeep() is called and the time since the last
|
||||||
upkeep exceeds the interval, then an HTTP/2 PING is sent. */
|
upkeep exceeds the interval, then an HTTP/2 PING is sent. */
|
||||||
curl_easy_conn_upkeep(curl);
|
curl_easy_upkeep(curl);
|
||||||
|
|
||||||
/* Perform more work here. */
|
/* Perform more work here. */
|
||||||
|
|
@ -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
|
.SH NAME
|
||||||
CURLOPT_CONN_UPKEEP_INTERVAL_MS \- connection upkeep interval
|
CURLOPT_UPKEEP_INTERVAL_MS \- connection upkeep interval
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
#include <curl/curl.h>
|
#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
|
.SH DESCRIPTION
|
||||||
Some protocols have "connection upkeep" mechanisms. These mechanisms usually
|
Some protocols have "connection upkeep" mechanisms. These mechanisms usually
|
||||||
send some traffic on existing connections in order to keep them alive; this
|
send some traffic on existing connections in order to keep them alive; this
|
||||||
can prevent connections from being closed due to overzealous firewalls, for
|
can prevent connections from being closed due to overzealous firewalls, for
|
||||||
example.
|
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.
|
perform the upkeep work.
|
||||||
|
|
||||||
Currently the only protocol with a connection upkeep mechanism is HTTP/2: when
|
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.
|
is called, an HTTP/2 PING frame is sent on the connection.
|
||||||
|
|
||||||
.SH DEFAULT
|
.SH DEFAULT
|
||||||
@ -50,16 +50,16 @@ if(curl) {
|
|||||||
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
||||||
|
|
||||||
/* Set the interval to 30000ms / 30s */
|
/* 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);
|
curl_easy_perform(curl);
|
||||||
|
|
||||||
/* Perform more work here. */
|
/* Perform more work here. */
|
||||||
|
|
||||||
/* While the connection is being held open, curl_easy_conn_upkeep() can be
|
/* While the connection is being held open, curl_easy_upkeep() can be
|
||||||
called. If curl_easy_conn_upkeep() is called and the time since the last
|
called. If curl_easy_upkeep() is called and the time since the last
|
||||||
upkeep exceeds the interval, then an HTTP/2 PING is sent. */
|
upkeep exceeds the interval, then an HTTP/2 PING is sent. */
|
||||||
curl_easy_conn_upkeep(curl);
|
curl_easy_upkeep(curl);
|
||||||
|
|
||||||
/* Perform more work here. */
|
/* Perform more work here. */
|
||||||
|
|
@ -94,7 +94,7 @@ man_MANS = \
|
|||||||
CURLOPT_CHUNK_END_FUNCTION.3 \
|
CURLOPT_CHUNK_END_FUNCTION.3 \
|
||||||
CURLOPT_CLOSESOCKETDATA.3 \
|
CURLOPT_CLOSESOCKETDATA.3 \
|
||||||
CURLOPT_CLOSESOCKETFUNCTION.3 \
|
CURLOPT_CLOSESOCKETFUNCTION.3 \
|
||||||
CURLOPT_CONN_UPKEEP_INTERVAL_MS.3 \
|
CURLOPT_UPKEEP_INTERVAL_MS.3 \
|
||||||
CURLOPT_CONNECTTIMEOUT.3 \
|
CURLOPT_CONNECTTIMEOUT.3 \
|
||||||
CURLOPT_CONNECTTIMEOUT_MS.3 \
|
CURLOPT_CONNECTTIMEOUT_MS.3 \
|
||||||
CURLOPT_CONNECT_ONLY.3 \
|
CURLOPT_CONNECT_ONLY.3 \
|
||||||
|
@ -356,7 +356,7 @@ CURLOPT_CLOSEFUNCTION 7.7 7.11.1 7.15.5
|
|||||||
CURLOPT_CLOSEPOLICY 7.7 7.16.1
|
CURLOPT_CLOSEPOLICY 7.7 7.16.1
|
||||||
CURLOPT_CLOSESOCKETDATA 7.21.7
|
CURLOPT_CLOSESOCKETDATA 7.21.7
|
||||||
CURLOPT_CLOSESOCKETFUNCTION 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 7.7
|
||||||
CURLOPT_CONNECTTIMEOUT_MS 7.16.2
|
CURLOPT_CONNECTTIMEOUT_MS 7.16.2
|
||||||
CURLOPT_CONNECT_ONLY 7.15.2
|
CURLOPT_CONNECT_ONLY 7.15.2
|
||||||
|
@ -1869,7 +1869,7 @@ typedef enum {
|
|||||||
CINIT(UPLOAD_BUFFERSIZE, LONG, 280),
|
CINIT(UPLOAD_BUFFERSIZE, LONG, 280),
|
||||||
|
|
||||||
/* Time in ms between connection upkeep calls for long-lived connections. */
|
/* 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 */
|
CURLOPT_LASTENTRY /* the last unused */
|
||||||
} CURLoption;
|
} CURLoption;
|
||||||
|
@ -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
|
* DESCRIPTION
|
||||||
*
|
*
|
||||||
* Performs connection upkeep for the given session handle.
|
* 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
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
@ -1201,7 +1201,7 @@ CURLcode curl_easy_send(struct Curl_easy *data, const void *buffer,
|
|||||||
/*
|
/*
|
||||||
* Performs connection upkeep for the given session handle.
|
* 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. */
|
/* Verify that we got an easy handle we can work with. */
|
||||||
if(!GOOD_EASY_HANDLE(data))
|
if(!GOOD_EASY_HANDLE(data))
|
||||||
@ -1209,7 +1209,7 @@ CURLcode curl_easy_conn_upkeep(struct Curl_easy *data)
|
|||||||
|
|
||||||
if(data->multi_easy) {
|
if(data->multi_easy) {
|
||||||
/* Use the common function to keep connections alive. */
|
/* 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 {
|
else {
|
||||||
/* No connections, so just return success */
|
/* No connections, so just return success */
|
||||||
|
@ -2624,7 +2624,7 @@ CURLcode Curl_vsetopt(struct Curl_easy *data, CURLoption option,
|
|||||||
va_arg(param, char *));
|
va_arg(param, char *));
|
||||||
data->set.doh = data->set.str[STRING_DOH]?TRUE:FALSE;
|
data->set.doh = data->set.str[STRING_DOH]?TRUE:FALSE;
|
||||||
break;
|
break;
|
||||||
case CURLOPT_CONN_UPKEEP_INTERVAL_MS:
|
case CURLOPT_UPKEEP_INTERVAL_MS:
|
||||||
arg = va_arg(param, long);
|
arg = va_arg(param, long);
|
||||||
if(arg < 0)
|
if(arg < 0)
|
||||||
return CURLE_BAD_FUNCTION_ARGUMENT;
|
return CURLE_BAD_FUNCTION_ARGUMENT;
|
||||||
|
@ -4871,7 +4871,7 @@ static int conn_upkeep(struct connectdata *conn,
|
|||||||
return 0; /* continue iteration */
|
return 0; /* continue iteration */
|
||||||
}
|
}
|
||||||
|
|
||||||
CURLcode Curl_conn_upkeep(struct conncache *conn_cache,
|
CURLcode Curl_upkeep(struct conncache *conn_cache,
|
||||||
void *data)
|
void *data)
|
||||||
{
|
{
|
||||||
/* Loop over every connection and make connection alive. */
|
/* Loop over every connection and make connection alive. */
|
||||||
|
@ -77,7 +77,7 @@ int Curl_removeHandleFromPipeline(struct Curl_easy *handle,
|
|||||||
void Curl_getoff_all_pipelines(struct Curl_easy *data,
|
void Curl_getoff_all_pipelines(struct Curl_easy *data,
|
||||||
struct connectdata *conn);
|
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_PROXY_PORT 1080 /* default proxy port unless specified */
|
||||||
#define CURL_DEFAULT_HTTPS_PROXY_PORT 443 /* default https proxy port unless
|
#define CURL_DEFAULT_HTTPS_PROXY_PORT 443 /* default https proxy port unless
|
||||||
|
@ -75,7 +75,7 @@ CURL_EXTERN CURL *curl_easy_duphandle(CURL *curl);
|
|||||||
CURL_EXTERN void curl_easy_reset(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_recv(CURL *curl, void *buffer, size_t buflen,
|
||||||
CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer,
|
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_mprintf(const char *format, ...);
|
||||||
CURL_EXTERN int curl_mfprintf(FILE *fd, const char *format, ...);
|
CURL_EXTERN int curl_mfprintf(FILE *fd, const char *format, ...);
|
||||||
CURL_EXTERN int curl_msprintf(char *buffer, const char *format, ...);
|
CURL_EXTERN int curl_msprintf(char *buffer, const char *format, ...);
|
||||||
|
Loading…
Reference in New Issue
Block a user