docs/libcurl/opts/CURLINFO_APPCONNECT_TIME.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
  24
  25 .SH NAME
  26 CURLINFO_APPCONNECT_TIME \- get the time until the SSL/SSH handshake is completed
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_TIME, double *timep);
  31 .SH DESCRIPTION
  32 Pass a pointer to a double to receive the time, in seconds, it took from the
  33 start until the SSL/SSH connect/handshake to the remote host was completed.
  34 This time is most often very near to the \fICURLINFO_PRETRANSFER_TIME(3)\fP
  35 time, except for cases such as HTTP pipelining where the pretransfer time can
  36 be delayed due to waits in line for the pipeline and more.
  37
  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   double 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_APPCONNECT_TIME, &connect);
  50     if(CURLE_OK == res) {
  51       printf("Time: %.1f", connect);
  52     }
  53   }
  54   /* always cleanup */
  55   curl_easy_cleanup(curl);
  56 }
  57 .fi
  58 .SH AVAILABILITY
  59 Added in 7.19.0
  60 .SH RETURN VALUE
  61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62 .SH "SEE ALSO"
  63 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "