| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLMOPT_PIPELINING 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLMOPT_PIPELINING \- enable HTTP pipelining and multiplexing |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING, long bitmask); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass in the \fBbitmask\fP parameter to instruct libcurl to enable HTTP |
| 32 |
pipelining and/or HTTP/2 multiplexing for this multi handle. |
| 33 |
|
| 34 |
When enabled, libcurl will attempt to use those protocol features when doing |
| 35 |
parallel requests to the same hosts. |
| 36 |
|
| 37 |
For pipelining, this means that if you add a second request that can use an |
| 38 |
already existing connection, the second request will be \&"piped" on the same |
| 39 |
connection rather than being executed in parallel. |
| 40 |
|
| 41 |
For multiplexing, this means that follow-up requests can re-use an existing |
| 42 |
connection and send the new request multiplexed over that at the same time as |
| 43 |
other transfers are already using that single connection. |
| 44 |
|
| 45 |
There are several other related options that are interesting to tweak and |
| 46 |
adjust to alter how libcurl spreads out requests on different connections or |
| 47 |
not etc. |
| 48 |
|
| 49 |
Before 7.43.0, this option was set to 1 and 0 to enable and disable HTTP/1.1 |
| 50 |
pipelining. |
| 51 |
|
| 52 |
Starting in 7.43.0, \fBbitmask\fP's second bit also has a meaning, and you can |
| 53 |
ask for pipelining and multiplexing independently of each other by toggling |
| 54 |
the correct bits. |
| 55 |
.IP CURLPIPE_NOTHING (0) |
| 56 |
Default, which means doing no attempts at pipelining or multiplexing. |
| 57 |
.IP CURLPIPE_HTTP1 (1) |
| 58 |
If this bit is set, libcurl will try to pipeline HTTP/1.1 requests on |
| 59 |
connections that are already established and in use to hosts. |
| 60 |
|
| 61 |
This bit is deprecated and has no effect since version 7.62.0. |
| 62 |
.IP CURLPIPE_MULTIPLEX (2) |
| 63 |
If this bit is set, libcurl will try to multiplex the new transfer over an |
| 64 |
existing connection if possible. This requires HTTP/2. |
| 65 |
.SH DEFAULT |
| 66 |
Since 7.62.0, \fBCURLPIPE_MULTIPLEX\fP is enabled by default. |
| 67 |
|
| 68 |
Before that, default was \fBCURLPIPE_NOTHING\fP. |
| 69 |
.SH PROTOCOLS |
| 70 |
HTTP(S) |
| 71 |
.SH EXAMPLE |
| 72 |
.nf |
| 73 |
CURLM *m = curl_multi_init(); |
| 74 |
/* try HTTP/2 multiplexing */ |
| 75 |
curl_multi_setopt(m, CURLMOPT_PIPELINING, CURLPIPE_MULTIPLEX); |
| 76 |
.fi |
| 77 |
.SH AVAILABILITY |
| 78 |
Added in 7.16.0. Multiplex support bit added in 7.43.0. HTTP/1 Pipelining |
| 79 |
support was disabled in 7.62.0. |
| 80 |
.SH RETURN VALUE |
| 81 |
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
| 82 |
.SH "SEE ALSO" |
| 83 |
.BR CURLMOPT_MAX_PIPELINE_LENGTH "(3), " |
| 84 |
.BR CURLMOPT_PIPELINING_SITE_BL "(3), " |
| 85 |
.BR CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE "(3), " |
| 86 |
.BR CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE "(3), " |
| 87 |
.BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), " |
| 88 |
.BR CURLMOPT_MAXCONNECTS "(3), " |
| 89 |
.BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), " |