blob: 7a8d7e0973bb3aab4962952174ab3f27dda6fce1 [file] [log] [blame]
Alex Deymo8f1a2142016-06-28 14:49:26 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughes82be86d2017-09-20 17:00:17 -07008.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Alex Deymo8f1a2142016-06-28 14:49:26 -07009.\" *
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.\"
Elliott Hughescac39802018-04-27 16:19:43 -070023.TH CURLINFO_APPCONNECT_TIME 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Alex Deymo8f1a2142016-06-28 14:49:26 -070025.SH NAME
26CURLINFO_APPCONNECT_TIME \- get the time until the SSL/SSH handshake is completed
27.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_TIME, double *timep);
31.SH DESCRIPTION
32Pass a pointer to a double to receive the time, in seconds, it took from the
33start until the SSL/SSH connect/handshake to the remote host was completed.
34This time is most often very near to the \fICURLINFO_PRETRANSFER_TIME(3)\fP
35time, except for cases such as HTTP pipelining where the pretransfer time can
36be delayed due to waits in line for the pipeline and more.
37
38See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
39.SH PROTOCOLS
40All
41.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070042.nf
43curl = curl_easy_init();
44if(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
Alex Deymo8f1a2142016-06-28 14:49:26 -070058.SH AVAILABILITY
59Added in 7.19.0
60.SH RETURN VALUE
61Returns 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), "