Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLMOPT_MAX_PIPELINE_LENGTH.3

raw
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_MAX_PIPELINE_LENGTH 3 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
24 .SH NAME
25 CURLMOPT_MAX_PIPELINE_LENGTH \- maximum number of requests in a pipeline
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_PIPELINE_LENGTH, long max);
30 .SH DESCRIPTION
31 No function since pipelining was removed in 7.62.0.
32
33 Pass a long. The set \fBmax\fP number will be used as the maximum amount of
34 outstanding requests in an HTTP/1.1 pipelined connection. This option is only
35 used for HTTP/1.1 pipelining, not for HTTP/2 multiplexing.
36
37 When this limit is reached, libcurl will use another connection to the same
38 host (see \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP), or queue the request until
39 one of the pipelines to the host is ready to accept a request. Thus, the
40 total number of requests in-flight is \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP *
41 \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
42 .SH DEFAULT
43 5
44 .SH PROTOCOLS
45 HTTP(S)
46 .SH EXAMPLE
47 .nf
48 CURLM *m = curl_multi_init();
49 /* set a more conservative pipe length */
50 curl_multi_setopt(m, CURLMOPT_MAX_PIPELINE_LENGTH, 3L);
51 .fi
52 .SH AVAILABILITY
53 Added in 7.30.0
54 .SH RETURN VALUE
55 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
56 .SH "SEE ALSO"
57 .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_MAX_HOST_CONNECTIONS "(3), "