CURLINFO_TOTAL_TIME.3 2.3 KB

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