Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME_T.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 2018 - 2019, Daniel Stenberg, <[email protected]>, 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 "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 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_TIME_T, curl_off_t *timep);
30 .SH DESCRIPTION
31 Pass a pointer to a curl_off_t to receive the time, in microseconds,
32 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_T(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 When a redirect is followed, the time from each request is added together.
39
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)"