CURLINFO_CONNECT_TIME_T.3 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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_CONNECT_TIME_T 3 "28 Apr 2018" "libcurl" "libcurl"
  26. .SH NAME
  27. CURLINFO_CONNECT_TIME_T \- get the time until connect
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONNECT_TIME_T,
  32. curl_off_t *timep);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a curl_off_t to receive the total time in microseconds from
  36. the start until the connection to the remote host (or proxy) was completed.
  37. When a redirect is followed, the time from each request is added together.
  38. See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
  39. .SH PROTOCOLS
  40. All
  41. .SH EXAMPLE
  42. .nf
  43. curl = curl_easy_init();
  44. if(curl) {
  45. curl_off_t connect;
  46. curl_easy_setopt(curl, CURLOPT_URL, url);
  47. res = curl_easy_perform(curl);
  48. if(CURLE_OK == res) {
  49. res = curl_easy_getinfo(curl, CURLINFO_CONNECT_TIME_T, &connect);
  50. if(CURLE_OK == res) {
  51. printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", connect / 1000000,
  52. (long)(connect % 1000000));
  53. }
  54. }
  55. /* always cleanup */
  56. curl_easy_cleanup(curl);
  57. }
  58. .fi
  59. .SH AVAILABILITY
  60. Added in 7.61.0
  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), " CURLINFO_CONNECT_TIME "(3)"