CURLINFO_APPCONNECT_TIME_T.3 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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_APPCONNECT_TIME_T 3 "28 Apr 2018" "libcurl 7.61.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_APPCONNECT_TIME_T \- get the time until the SSL/SSH handshake is completed
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_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, it took
  34. from the start until the SSL/SSH connect/handshake to the remote host was
  35. completed. This time is most often close to the
  36. \fICURLINFO_PRETRANSFER_TIME_T(3)\fP time, except for cases such as HTTP
  37. pipelining where the pretransfer time can be delayed due to waits in line for
  38. the pipeline and more.
  39. When a redirect is followed, the time from each request is added together.
  40. See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
  41. .SH PROTOCOLS
  42. All
  43. .SH EXAMPLE
  44. .nf
  45. curl = curl_easy_init();
  46. if(curl) {
  47. curl_off_t connect;
  48. curl_easy_setopt(curl, CURLOPT_URL, url);
  49. res = curl_easy_perform(curl);
  50. if(CURLE_OK == res) {
  51. res = curl_easy_getinfo(curl, CURLINFO_APPCONNECT_TIME_T, &connect);
  52. if(CURLE_OK == res) {
  53. printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", connect / 1000000,
  54. (long)(connect % 1000000));
  55. }
  56. }
  57. /* always cleanup */
  58. curl_easy_cleanup(curl);
  59. }
  60. .fi
  61. .SH AVAILABILITY
  62. Added in 7.61.0
  63. .SH RETURN VALUE
  64. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  65. .SH "SEE ALSO"
  66. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " CURLINFO_APPCONNECT_TIME "(3)"