CURLINFO_APPCONNECT_TIME_T.3 2.6 KB

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