1---
2c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_APPCONNECT_TIME_T
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_APPCONNECT_TIME (3)
9  - curl_easy_getinfo (3)
10  - curl_easy_setopt (3)
11---
12
13# NAME
14
15CURLINFO_APPCONNECT_TIME_T - time until the SSL/SSH handshake completed
16
17# SYNOPSIS
18
19~~~c
20#include <curl/curl.h>
21
22CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_TIME_T,
23                           curl_off_t *timep);
24~~~
25
26# DESCRIPTION
27
28Pass a pointer to a curl_off_t to receive the time, in microseconds, it took
29from the start until the SSL/SSH connect/handshake to the remote host was
30completed. This time is most often close to the
31CURLINFO_PRETRANSFER_TIME_T(3) time, except for cases such as HTTP
32pipelining where the pretransfer time can be delayed due to waits in line for
33the pipeline and more.
34
35When a redirect is followed, the time from each request is added together.
36
37See also the TIMES overview in the curl_easy_getinfo(3) man page.
38
39# PROTOCOLS
40
41All
42
43# EXAMPLE
44
45~~~c
46int main(void)
47{
48  CURL *curl = curl_easy_init();
49  if(curl) {
50    CURLcode res;
51    curl_off_t connect;
52    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
53    res = curl_easy_perform(curl);
54    if(CURLE_OK == res) {
55      res = curl_easy_getinfo(curl, CURLINFO_APPCONNECT_TIME_T, &connect);
56      if(CURLE_OK == res) {
57        printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", connect / 1000000,
58               (long)(connect % 1000000));
59      }
60    }
61    /* always cleanup */
62    curl_easy_cleanup(curl);
63  }
64}
65~~~
66
67# AVAILABILITY
68
69Added in 7.61.0
70
71# RETURN VALUE
72
73Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
74