CURLMOPT_MAX_PIPELINE_LENGTH.3 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. .\" generated by cd2nroff 0.1 from CURLMOPT_MAX_PIPELINE_LENGTH.md
  2. .TH CURLMOPT_MAX_PIPELINE_LENGTH 3 "2025-01-17" libcurl
  3. .SH NAME
  4. CURLMOPT_MAX_PIPELINE_LENGTH \- maximum number of requests in a pipeline
  5. .SH SYNOPSIS
  6. .nf
  7. #include <curl/curl.h>
  8. CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_PIPELINE_LENGTH,
  9. long max);
  10. .fi
  11. .SH DESCRIPTION
  12. No function since pipelining was removed in 7.62.0.
  13. Pass a long. The set \fBmax\fP number is used as the maximum amount of
  14. outstanding requests in an HTTP/1.1 pipeline. This option is only used for
  15. HTTP/1.1 pipelining, not for HTTP/2 multiplexing.
  16. When this limit is reached, libcurl creates another connection to the same
  17. host (see \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP), or queue the request until one
  18. .nf
  19. of the pipelines to the host is ready to accept a request. Thus, the total
  20. .fi
  21. \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
  22. .SH DEFAULT
  23. 5
  24. .SH PROTOCOLS
  25. This functionality affects all supported protocols
  26. .SH EXAMPLE
  27. .nf
  28. int main(void)
  29. {
  30. CURLM *m = curl_multi_init();
  31. /* set a more conservative pipe length */
  32. curl_multi_setopt(m, CURLMOPT_MAX_PIPELINE_LENGTH, 3L);
  33. }
  34. .fi
  35. .SH AVAILABILITY
  36. Added in curl 7.30.0
  37. .SH RETURN VALUE
  38. Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  39. .SH SEE ALSO
  40. .BR CURLMOPT_MAX_HOST_CONNECTIONS (3),
  41. .BR CURLMOPT_PIPELINING (3)