2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_PIPEWAIT.md
|
2024-06-01 14:49:19 -06:00
|
|
|
.TH CURLOPT_PIPEWAIT 3 "2024-06-01" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_PIPEWAIT \- wait for multiplexing
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PIPEWAIT, long wait);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Set \fIwait\fP to 1L to tell libcurl to prefer to wait for a connection to
|
|
|
|
|
confirm or deny that it can do multiplexing before continuing.
|
|
|
|
|
|
|
|
|
|
When about to perform a new transfer that allows multiplexing, libcurl checks
|
|
|
|
|
for existing connections to use. If no such connection exists it immediately
|
|
|
|
|
continues and creates a fresh new connection to use.
|
|
|
|
|
|
|
|
|
|
By setting this option to 1 \- and having \fICURLMOPT_PIPELINING(3)\fP enabled
|
|
|
|
|
for the multi handle this transfer is associated with \- libcurl instead waits
|
|
|
|
|
for the connection to reveal if it is possible to multiplex on before it
|
|
|
|
|
continues. This enables libcurl to much better keep the number of connections
|
|
|
|
|
to a minimum when using multiplexing protocols.
|
|
|
|
|
|
|
|
|
|
With this option set, libcurl prefers to wait and reuse an existing connection
|
|
|
|
|
for multiplexing rather than the opposite: prefer to open a new connection
|
|
|
|
|
rather than waiting.
|
|
|
|
|
|
|
|
|
|
The waiting time is as long as it takes for the connection to get up and for
|
|
|
|
|
libcurl to get the necessary response back that informs it about its protocol
|
|
|
|
|
and support level.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
0 (off)
|
|
|
|
|
.SH PROTOCOLS
|
2024-03-30 12:28:04 -06:00
|
|
|
HTTP
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_PIPEWAIT, 1L);
|
|
|
|
|
|
|
|
|
|
/* now add this easy handle to the multi handle */
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
|
|
|
|
Added in 7.43.0
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLMOPT_MAX_HOST_CONNECTIONS (3),
|
|
|
|
|
.BR CURLMOPT_PIPELINING (3),
|
|
|
|
|
.BR CURLOPT_FORBID_REUSE (3),
|
|
|
|
|
.BR CURLOPT_FRESH_CONNECT (3)
|
