1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_STARTTRANSFER_TIME
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_STARTTRANSFER_TIME_T (3)
9  - CURLOPT_TIMEOUT (3)
10  - curl_easy_getinfo (3)
11  - curl_easy_setopt (3)
12Protocol:
13  - All
14Added-in: 7.9.2
15---
16
17# NAME
18
19CURLINFO_STARTTRANSFER_TIME - get the time until the first byte is received
20
21# SYNOPSIS
22
23~~~c
24#include <curl/curl.h>
25
26CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_STARTTRANSFER_TIME,
27                           double *timep);
28~~~
29
30# DESCRIPTION
31
32Pass a pointer to a double to receive the time, in seconds, it took from the
33start until the first byte is received by libcurl. This includes
34CURLINFO_PRETRANSFER_TIME(3) and also the time the server needs to
35calculate the result.
36
37When a redirect is followed, the time from each request is added together.
38
39See also the TIMES overview in the curl_easy_getinfo(3) man page.
40
41# %PROTOCOLS%
42
43# EXAMPLE
44
45~~~c
46int main(void)
47{
48  CURL *curl = curl_easy_init();
49  if(curl) {
50    CURLcode res;
51    double start;
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_STARTTRANSFER_TIME, &start);
56      if(CURLE_OK == res) {
57        printf("Time: %.1f", start);
58      }
59    }
60    /* always cleanup */
61    curl_easy_cleanup(curl);
62  }
63}
64~~~
65
66# %AVAILABILITY%
67
68# RETURN VALUE
69
70Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
71