2
0

CURLMOPT_MAX_PIPELINE_LENGTH.3 2.4 KB

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