docs/libcurl/opts/CURLMOPT_MAX_PIPELINE_LENGTH.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_MAX_PIPELINE_LENGTH 3 "May 27, 2017" "libcurl 7.59.0" "curl_multi_setopt options"
  24
  25 .SH NAME
  26 CURLMOPT_MAX_PIPELINE_LENGTH \- maximum number of requests in a pipeline
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_PIPELINE_LENGTH, long max);
  31 .SH DESCRIPTION
  32 Pass a long. The set \fBmax\fP number will be used as the maximum amount of
  33 outstanding requests in an HTTP/1.1 pipelined connection. This option is only
  34 used for HTTP/1.1 pipelining, not for HTTP/2 multiplexing.
  35
  36 When this limit is reached, libcurl will use another connection to the same
  37 host (see \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP), or queue the request until
  38 one of the pipelines to the host is ready to accept a request.  Thus, the
  39 total number of requests in-flight is \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP *
  40 \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
  41 .SH DEFAULT
  42 5
  43 .SH PROTOCOLS
  44 HTTP(S)
  45 .SH EXAMPLE
  46 .nf
  47 CURLM *m = curl_multi_init();
  48 /* set a more conservative pipe length */
  49 curl_multi_setopt(m, CURLMOPT_MAX_PIPELINE_LENGTH, 3L);
  50 .fi
  51 .SH AVAILABILITY
  52 Added in 7.30.0
  53 .SH RETURN VALUE
  54 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  55 .SH "SEE ALSO"
  56 .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_MAX_HOST_CONNECTIONS "(3), "