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