Annotation of embedaddon/curl/docs/libcurl/opts/CURLMOPT_MAX_PIPELINE_LENGTH.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, 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 "April 05, 2019" "libcurl 7.70.0" "curl_multi_setopt options"
24:
25: .SH NAME
26: CURLMOPT_MAX_PIPELINE_LENGTH \- maximum number of requests in a pipeline
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_PIPELINE_LENGTH, long max);
31: .SH DESCRIPTION
32: No function since pipelining was removed in 7.62.0.
33:
34: Pass a long. The set \fBmax\fP number will be used as the maximum amount of
35: outstanding requests in an HTTP/1.1 pipelined connection. This option is only
36: used for HTTP/1.1 pipelining, not for HTTP/2 multiplexing.
37:
38: When this limit is reached, libcurl will use another connection to the same
39: host (see \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP), or queue the request until
40: one of the pipelines to the host is ready to accept a request. Thus, the
41: total number of requests in-flight is \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP *
42: \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
43: .SH DEFAULT
44: 5
45: .SH PROTOCOLS
46: HTTP(S)
47: .SH EXAMPLE
48: .nf
49: CURLM *m = curl_multi_init();
50: /* set a more conservative pipe length */
51: curl_multi_setopt(m, CURLMOPT_MAX_PIPELINE_LENGTH, 3L);
52: .fi
53: .SH AVAILABILITY
54: Added in 7.30.0
55: .SH RETURN VALUE
56: Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
57: .SH "SEE ALSO"
58: .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_MAX_HOST_CONNECTIONS "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>