CURLMOPT_MAX_TOTAL_CONNECTIONS.3 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .\" generated by cd2nroff 0.1 from CURLMOPT_MAX_TOTAL_CONNECTIONS.md
  2. .TH CURLMOPT_MAX_TOTAL_CONNECTIONS 3 "2025-01-17" libcurl
  3. .SH NAME
  4. CURLMOPT_MAX_TOTAL_CONNECTIONS \- max simultaneously open connections
  5. .SH SYNOPSIS
  6. .nf
  7. #include <curl/curl.h>
  8. CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_TOTAL_CONNECTIONS,
  9. long amount);
  10. .fi
  11. .SH DESCRIPTION
  12. Pass a long for the \fBamount\fP. The set number is used as the maximum number
  13. of simultaneously open connections in total using this multi handle. For each
  14. new session, libcurl might open a new connection up to the limit set by
  15. \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP. When the limit is reached, new
  16. sessions are held pending until there are available connections. If
  17. \fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl can try multiplexing if the
  18. host is capable of it.
  19. When more transfers are added to the multi handle than what can be performed
  20. due to the set limit, they get queued up waiting for their chance. When that
  21. happens, the \fICURLOPT_TIMEOUT_MS(3)\fP timeout is counted inclusive of the
  22. waiting time, meaning that if you set a too narrow timeout in such a case the
  23. transfer might never even start before it times out.
  24. Even in the queued up situation, the \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP
  25. timeout is however treated as a per\-connect timeout.
  26. .SH DEFAULT
  27. 0, which means that there is no limit. It is then simply controlled by the
  28. number of easy handles added.
  29. .SH PROTOCOLS
  30. This functionality affects all supported protocols
  31. .SH EXAMPLE
  32. .nf
  33. int main(void)
  34. {
  35. CURLM *m = curl_multi_init();
  36. /* never do more than 15 connections */
  37. curl_multi_setopt(m, CURLMOPT_MAX_TOTAL_CONNECTIONS, 15L);
  38. }
  39. .fi
  40. .SH AVAILABILITY
  41. Added in curl 7.30.0
  42. .SH RETURN VALUE
  43. Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  44. .SH SEE ALSO
  45. .BR CURLMOPT_MAXCONNECTS (3),
  46. .BR CURLMOPT_MAX_HOST_CONNECTIONS (3)