Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE.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_CHUNK_LENGTH_PENALTY_SIZE 3 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
24 .SH NAME
25 CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE \- chunk length threshold for pipelining
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, long size);
30 .SH DESCRIPTION
31 No function since pipelining was removed in 7.62.0.
32
33 Pass a long with a \fBsize\fP in bytes. If a pipelined connection is currently
34 processing a chunked (Transfer-encoding: chunked) request with a current chunk
35 length larger than \fICURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3)\fP, that pipeline
36 will not be considered for additional requests, even if it is shorter than
37 \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
38 .SH DEFAULT
39 The default value is 0, which means that the penalization is inactive.
40 .SH PROTOCOLS
41 HTTP(S)
42 .SH EXAMPLE
43 .nf
44 CURLM *m = curl_multi_init();
45 long maxchunk = 10000;
46 curl_multi_setopt(m, CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, maxchunk);
47 .fi
48 .SH AVAILABILITY
49 Added in 7.30.0
50 .SH RETURN VALUE
51 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
52 .SH "SEE ALSO"
53 .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE "(3), "
54 .BR CURLMOPT_MAX_PIPELINE_LENGTH "(3), "