CURLINFO_TOTAL_TIME_T.3 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 2018 - 2021, 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_TOTAL_TIME_T 3 "28 Apr 2018" "libcurl 7.61.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_TOTAL_TIME_T \- get total time of previous transfer in microseconds
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_TOTAL_TIME_T,
  30. curl_off_t *timep);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a pointer to a curl_off_t to receive the total time in microseconds
  34. for the previous transfer, including name resolving, TCP connect etc.
  35. The curl_off_t represents the time in microseconds.
  36. When a redirect is followed, the time from each request is added together.
  37. See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
  38. .SH PROTOCOLS
  39. All
  40. .SH EXAMPLE
  41. .nf
  42. curl = curl_easy_init();
  43. if(curl) {
  44. curl_off_t total;
  45. curl_easy_setopt(curl, CURLOPT_URL, url);
  46. res = curl_easy_perform(curl);
  47. if(CURLE_OK == res) {
  48. res = curl_easy_getinfo(curl, CURLINFO_TOTAL_TIME_T, &total);
  49. if(CURLE_OK == res) {
  50. printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", total / 1000000,
  51. (long)(total % 1000000));
  52. }
  53. }
  54. /* always cleanup */
  55. curl_easy_cleanup(curl);
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 7.61.0
  60. .SH RETURN VALUE
  61. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62. .SH "SEE ALSO"
  63. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " CURLINFO_TOTAL_TIME "(3)"