1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_STARTTRANSFER_TIME_T
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_STARTTRANSFER_TIME (3)
9  - CURLOPT_TIMEOUT (3)
10  - curl_easy_getinfo (3)
11  - curl_easy_setopt (3)
12Protocol:
13  - All
14---
15
16# NAME
17
18CURLINFO_STARTTRANSFER_TIME_T - get the time until the first byte is received
19
20# SYNOPSIS
21
22~~~c
23#include <curl/curl.h>
24
25CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_STARTTRANSFER_TIME_T,
26                           curl_off_t *timep);
27~~~
28
29# DESCRIPTION
30
31Pass a pointer to a curl_off_t to receive the time, in microseconds,
32it took from the
33start until the first byte is received by libcurl. This includes
34CURLINFO_PRETRANSFER_TIME_T(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# EXAMPLE
42
43~~~c
44int main(void)
45{
46  CURL *curl = curl_easy_init();
47  if(curl) {
48    CURLcode res;
49    curl_off_t start;
50    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
51    res = curl_easy_perform(curl);
52    if(CURLE_OK == res) {
53      res = curl_easy_getinfo(curl, CURLINFO_STARTTRANSFER_TIME_T, &start);
54      if(CURLE_OK == res) {
55        printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", start / 1000000,
56               (long)(start % 1000000));
57      }
58    }
59    /* always cleanup */
60    curl_easy_cleanup(curl);
61  }
62}
63~~~
64
65# AVAILABILITY
66
67Added in 7.61.0
68
69# RETURN VALUE
70
71Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
72