docs/libcurl/opts/CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 "May 27, 2017" "libcurl 7.59.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 Pass a long with a \fBsize\fP in bytes. If a pipelined connection is currently
  33 processing a chunked (Transfer-encoding: chunked) request with a current chunk
  34 length larger than \fICURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3)\fP, that pipeline
  35 will not be considered for additional requests, even if it is shorter than
  36 \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
  37 .SH DEFAULT
  38 The default value is 0, which means that the penalization is inactive.
  39 .SH PROTOCOLS
  40 HTTP(S)
  41 .SH EXAMPLE
  42 .nf
  43 CURLM *m = curl_multi_init();
  44 long maxchunk = 10000;
  45 curl_multi_setopt(m, CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, maxchunk);
  46 .fi
  47 .SH AVAILABILITY
  48 Added in 7.30.0
  49 .SH RETURN VALUE
  50 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  51 .SH "SEE ALSO"
  52 .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE "(3), "
  53 .BR CURLMOPT_MAX_PIPELINE_LENGTH "(3), "