docs/libcurl/opts/CURLMOPT_PIPELINING.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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_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, long bits);
  30 .SH DESCRIPTION
  31 Set the \fBbits\fP parameter to 1 to make libcurl use HTTP pipelining for
  32 HTTP/1.1 transfers done using this multi handle, as far as possible. This
  33 means that if you add a second request that can use an already existing
  34 connection, the second request will be \&"piped" on the same connection rather
  35 than being 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
  41 Starting in 7.43.0, the \fBbits\fP parameter's bit 1 also has a meaning and
  42 libcurl is now offering symbol names for the bits:
  43 .IP CURLPIPE_NOTHING (0)
  44 Default, which means doing no attempts at pipelining or multiplexing.
  45 .IP CURLPIPE_HTTP1 (1)
  46 If this bit is set, libcurl will try to pipeline HTTP/1.1 requests on
  47 connections that are already established and in use to hosts.
  48 .IP CURLPIPE_MULTIPLEX (2)
  49 If this bit is set, libcurl will try to multiplex the new transfer over an
  50 existing connection if possible. This requires HTTP/2.
  51 .SH DEFAULT
  52 0 (off)
  53 .SH PROTOCOLS
  54 HTTP(S)
  55 .SH EXAMPLE
  56 TODO
  57 .SH AVAILABILITY
  58 Added in 7.16.0. Multiplex support bit added in 7.43.0.
  59 .SH RETURN VALUE
  60 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  61 .SH "SEE ALSO"
  62 .BR CURLMOPT_MAX_PIPELINE_LENGTH "(3), "
  63 .BR CURLMOPT_PIPELINING_SITE_BL "(3), "
  64 .BR CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE "(3), "
  65 .BR CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE "(3), "
  66 .BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "
  67 .BR CURLMOPT_MAXCONNECTS "(3), "
  68 .BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "