CURLINFO_STARTTRANSFER_TIME_T.3 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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_STARTTRANSFER_TIME_T 3 "28 Apr 2018" "libcurl 7.61.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_STARTTRANSFER_TIME_T \- get the time until the first byte is received
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_STARTTRANSFER_TIME_T,
  30. curl_off_t *timep);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a pointer to a curl_off_t to receive the time, in microseconds,
  34. it took from the
  35. start until the first byte is received by libcurl. This includes
  36. \fICURLINFO_PRETRANSFER_TIME_T(3)\fP and also the time the server needs to
  37. calculate the result.
  38. When a redirect is followed, the time from each request is added together.
  39. See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
  40. .SH PROTOCOLS
  41. All
  42. .SH EXAMPLE
  43. .nf
  44. curl = curl_easy_init();
  45. if(curl) {
  46. curl_off_t start;
  47. curl_easy_setopt(curl, CURLOPT_URL, url);
  48. res = curl_easy_perform(curl);
  49. if(CURLE_OK == res) {
  50. res = curl_easy_getinfo(curl, CURLINFO_STARTTRANSFER_TIME_T, &start);
  51. if(CURLE_OK == res) {
  52. printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", start / 1000000,
  53. (long)(start % 1000000));
  54. }
  55. }
  56. /* always cleanup */
  57. curl_easy_cleanup(curl);
  58. }
  59. .fi
  60. .SH AVAILABILITY
  61. Added in 7.61.0
  62. .SH RETURN VALUE
  63. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  64. .SH "SEE ALSO"
  65. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " CURLINFO_STARTTRANSFER_TIME "(3)"