2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLMOPT_PIPELINING.md
|
2024-09-15 18:10:01 -06:00
|
|
|
.TH CURLMOPT_PIPELINING 3 "2024-09-15" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
2024-06-01 14:49:19 -06:00
|
|
|
CURLMOPT_PIPELINING \- enable HTTP multiplexing
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING, long bitmask);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2024-06-01 14:49:19 -06:00
|
|
|
Pass in the correct value in the \fBbitmask\fP parameter to instruct libcurl to
|
|
|
|
|
enable multiplexing for this multi handle.
|
2024-03-15 20:55:33 -06:00
|
|
|
|
|
|
|
|
With multiplexing enabled, libcurl attempts to do multiple transfers over the
|
|
|
|
|
same connection when doing parallel transfers to the same hosts.
|
|
|
|
|
.IP "CURLPIPE_NOTHING (0)"
|
|
|
|
|
Default, which means doing no attempts at multiplexing.
|
|
|
|
|
.IP "CURLPIPE_HTTP1 (1)"
|
|
|
|
|
This bit is deprecated and has no effect since version 7.62.0.
|
|
|
|
|
.IP "CURLPIPE_MULTIPLEX (2)"
|
|
|
|
|
If this bit is set, libcurl tries to multiplex the new transfer over an
|
|
|
|
|
existing connection if possible. This requires HTTP/2 or HTTP/3.
|
|
|
|
|
.SH DEFAULT
|
2024-07-29 18:00:04 -06:00
|
|
|
\fBCURLPIPE_MULTIPLEX\fP
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects http only
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURLM *m = curl_multi_init();
|
|
|
|
|
/* try HTTP/2 multiplexing */
|
|
|
|
|
curl_multi_setopt(m, CURLMOPT_PIPELINING, CURLPIPE_MULTIPLEX);
|
|
|
|
|
}
|
|
|
|
|
.fi
|
2024-07-29 18:00:04 -06:00
|
|
|
.SH HISTORY
|
|
|
|
|
The multiplex support bit was added in 7.43.0. HTTP/1 Pipelining support was
|
|
|
|
|
disabled in 7.62.0.
|
|
|
|
|
|
|
|
|
|
Since 7.62.0, \fBCURLPIPE_MULTIPLEX\fP is enabled by default.
|
|
|
|
|
|
|
|
|
|
Before that, default was \fBCURLPIPE_NOTHING\fP.
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.16.0
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE (3),
|
|
|
|
|
.BR CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE (3),
|
|
|
|
|
.BR CURLMOPT_MAXCONNECTS (3),
|
|
|
|
|
.BR CURLMOPT_MAX_HOST_CONNECTIONS (3),
|
|
|
|
|
.BR CURLMOPT_MAX_PIPELINE_LENGTH (3),
|
|
|
|
|
.BR CURLMOPT_PIPELINING_SITE_BL (3)
|
