docs/libcurl/opts/CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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_CONTENT_LENGTH_PENALTY_SIZE 3 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
  24 .SH NAME
  25 CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE \- size threshold for pipelining penalty
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE, long size);
  30 .SH DESCRIPTION
  31 Pass a long with a \fBsize\fP in bytes. If a pipelined connection is currently
  32 processing a request with a Content-Length larger than this
  33 \fICURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3)\fP, that pipeline will then not be
  34 considered for additional requests, even if it is shorter than
  35 \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
  36 .SH DEFAULT
  37 The default value is 0, which means that the size penalization is inactive.
  38 .SH PROTOCOLS
  39 HTTP(S)
  40 .SH EXAMPLE
  41 TODO
  42 .SH AVAILABILITY
  43 Added in 7.30.0
  44 .SH RETURN VALUE
  45 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  46 .SH "SEE ALSO"
  47 .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE "(3), "