Return to CURLINFO_APPCONNECT_TIME_T.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME_T.3, revision 1.1.1.1

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