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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>