CURLINFO_NUM_CONNECTS.3 2.4 KB

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