CURLMOPT_MAX_TOTAL_CONNECTIONS.3 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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_TOTAL_CONNECTIONS 3 "May 27, 2017" "libcurl 7.61.1" "curl_multi_setopt options"
  24. .SH NAME
  25. CURLMOPT_MAX_TOTAL_CONNECTIONS \- max simultaneously open connections
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_TOTAL_CONNECTIONS, long amount);
  29. .SH DESCRIPTION
  30. Pass a long for the \fBamount\fP. The set number will be used as the maximum
  31. number of simultaneously open connections in total using this multi
  32. handle. For each new session, libcurl will open a new connection up to the
  33. limit set by \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP. When the limit is
  34. reached, the sessions will be pending until there are available
  35. connections. If \fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl will try to
  36. pipeline or use multiplexing if the host is capable of it.
  37. .SH DEFAULT
  38. The default value is 0, which means that there is no limit. It is then simply
  39. controlled by the number of easy handles added.
  40. .SH PROTOCOLS
  41. All
  42. .SH EXAMPLE
  43. .nf
  44. CURLM *m = curl_multi_init();
  45. /* never do more than 15 connections */
  46. curl_multi_setopt(m, CURLMOPT_MAX_TOTAL_CONNECTIONS, 15L);
  47. .fi
  48. .SH AVAILABILITY
  49. Added in 7.30.0
  50. .SH RETURN VALUE
  51. Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  52. .SH "SEE ALSO"
  53. .BR CURLMOPT_MAXCONNECTS "(3), " CURLMOPT_MAX_HOST_CONNECTIONS "(3), "