CURLMOPT_MAX_CONCURRENT_STREAMS.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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_CONCURRENT_STREAMS 3 "06 Nov 2019" "libcurl 7.67.0" "curl_multi_setopt options"
  24. .SH NAME
  25. CURLMOPT_MAX_CONCURRENT_STREAMS \- set max concurrent streams for http2
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_CONCURRENT_STREAMS,
  30. long max);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a long indicating the \fBmax\fP. The set number will be used as the
  34. maximum number of concurrent streams for a connections that libcurl should
  35. support on connections done using HTTP/2.
  36. Valid values range from 1 to 2147483647 (2^31 - 1) and defaults to 100. The
  37. value passed here would be honoured based on other system resources
  38. properties.
  39. .SH DEFAULT
  40. 100
  41. .SH PROTOCOLS
  42. All
  43. .SH EXAMPLE
  44. .nf
  45. CURLM *m = curl_multi_init();
  46. /* max concurrent streams 200 */
  47. curl_multi_setopt(m, CURLMOPT_MAX_CONCURRENT_STREAMS, 200L);
  48. .fi
  49. .SH AVAILABILITY
  50. Added in 7.67.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 CURLOPT_MAXCONNECTS "(3), " CURLMOPT_MAXCONNECTS "(3), "