1---
2c: Copyright (C) Daniel Stenberg, <daniel.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)
12---
13
14# NAME
15
16CURLINFO_STARTTRANSFER_TIME_T - 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_T,
24                           curl_off_t *timep);
25~~~
26
27# DESCRIPTION
28
29Pass a pointer to a curl_off_t to receive the time, in microseconds,
30it took from the
31start until the first byte is received by libcurl. This includes
32CURLINFO_PRETRANSFER_TIME_T(3) and also the time the server needs to
33calculate the result.
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 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_T, &start);
56      if(CURLE_OK == res) {
57        printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", start / 1000000,
58               (long)(start % 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