CURLINFO_APPCONNECT_TIME_T.3 2.5 KB

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