CURLMOPT_MAX_CONCURRENT_STREAMS.3 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLMOPT_MAX_CONCURRENT_STREAMS 3 "January 02, 2023" "libcurl 7.88.1" "curl_multi_setopt options"
  26. .SH NAME
  27. CURLMOPT_MAX_CONCURRENT_STREAMS \- max concurrent streams for http2
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_CONCURRENT_STREAMS,
  32. long max);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a long indicating the \fBmax\fP. The set number will be used as the
  36. maximum number of concurrent streams for a connections that libcurl should
  37. support on connections done using HTTP/2.
  38. Valid values range from 1 to 2147483647 (2^31 - 1) and defaults to 100. The
  39. value passed here would be honored based on other system resources properties.
  40. .SH DEFAULT
  41. 100
  42. .SH PROTOCOLS
  43. All
  44. .SH EXAMPLE
  45. .nf
  46. CURLM *m = curl_multi_init();
  47. /* max concurrent streams 200 */
  48. curl_multi_setopt(m, CURLMOPT_MAX_CONCURRENT_STREAMS, 200L);
  49. .fi
  50. .SH AVAILABILITY
  51. Added in 7.67.0
  52. .SH RETURN VALUE
  53. Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  54. .SH "SEE ALSO"
  55. .BR CURLOPT_MAXCONNECTS "(3), " CURLMOPT_MAXCONNECTS "(3), "