docs/libcurl/opts/CURLMOPT_PIPELINING.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_PIPELINING 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options"
  24 .SH NAME
  25 CURLMOPT_PIPELINING \- enable/disable HTTP pipelining
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING, bool onoff);
  30 .SH DESCRIPTION
  31 Set the \fBonoff\fP parameter to 1 to make libcurl use HTTP pipelining for
  32 HTTP transfers done using this multi handle, as far as possible. This means
  33 that if you add a second request that can use an already existing connection,
  34 the second request will be \&"piped" on the same connection rather than being
  35 executed in parallel.
  36
  37 When using pipelining, there are also several other related options that are
  38 interesting to tweak and adjust to alter how libcurl spreads out requests on
  39 different connections or not etc.
  40 .SH DEFAULT
  41 0 (off)
  42 .SH PROTOCOLS
  43 HTTP(S)
  44 .SH EXAMPLE
  45 TODO
  46 .SH AVAILABILITY
  47 Added in 7.16.0
  48 .SH RETURN VALUE
  49 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  50 .SH "SEE ALSO"
  51 .BR CURLMOPT_MAX_PIPELINE_LENGTH "(3), "
  52 .BR CURLMOPT_PIPELINING_SITE_BL "(3), "
  53 .BR CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE "(3), "
  54 .BR CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE "(3), "
  55 .BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "
  56 .BR CURLMOPT_MAXCONNECTS "(3), "
  57 .BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "