CURLMOPT_MAXCONNECTS.3 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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_MAXCONNECTS 3 "May 27, 2017" "libcurl 7.61.1" "curl_multi_setopt options"
  24. .SH NAME
  25. CURLMOPT_MAXCONNECTS \- set size of connection cache
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAXCONNECTS, long max);
  29. .SH DESCRIPTION
  30. Pass a long indicating the \fBmax\fP. The set number will be used as the
  31. maximum amount of simultaneously open connections that libcurl may keep in its
  32. connection cache after completed use. By default libcurl will enlarge the size
  33. for each added easy handle to make it fit 4 times the number of added easy
  34. handles.
  35. By setting this option, you can prevent the cache size from growing beyond the
  36. limit set by you.
  37. When the cache is full, curl closes the oldest one in the cache to prevent the
  38. number of open connections from increasing.
  39. This option is for the multi handle's use only, when using the easy interface
  40. you should instead use the \fICURLOPT_MAXCONNECTS(3)\fP option.
  41. See \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP for limiting the number of active
  42. connections.
  43. .SH DEFAULT
  44. See DESCRIPTION
  45. .SH PROTOCOLS
  46. All
  47. .SH EXAMPLE
  48. .nf
  49. CURLM *m = curl_multi_init();
  50. /* only keep 10 connections in the cache */
  51. curl_multi_setopt(m, CURLMOPT_MAXCONNECTS, 10L);
  52. .fi
  53. .SH AVAILABILITY
  54. Added in 7.16.3
  55. .SH RETURN VALUE
  56. Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  57. .SH "SEE ALSO"
  58. .BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "
  59. .BR CURLOPT_MAXCONNECTS "(3), "