CURLINFO_NUM_CONNECTS.3 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  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.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 CURLINFO_NUM_CONNECTS 3 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_NUM_CONNECTS \- get number of created connections
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_NUM_CONNECTS, long *nump);
  29. .SH DESCRIPTION
  30. Pass a pointer to a long to receive how many new connections libcurl had to
  31. create to achieve the previous transfer (only the successful connects are
  32. counted). Combined with \fICURLINFO_REDIRECT_COUNT(3)\fP you are able to know
  33. how many times libcurl successfully reused existing connection(s) or not. See
  34. the connection options of \fIcurl_easy_setopt(3)\fP to see how libcurl tries
  35. to make persistent connections to save time.
  36. .SH PROTOCOLS
  37. All
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. CURLcode res;
  43. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  44. curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  45. res = curl_easy_perform(curl);
  46. if(res == CURLE_OK) {
  47. long connects;
  48. res = curl_easy_getinfo(curl, CURLINFO_NUM_CONNECTS, &connects);
  49. if(res)
  50. printf("It needed %d connects\\n", connects);
  51. }
  52. curl_easy_cleanup(curl);
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. Added in 7.12.3
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  59. .SH "SEE ALSO"
  60. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "