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
14Added-in: 7.61.0
15---
16
17# NAME
18
19CURLINFO_STARTTRANSFER_TIME_T - 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_T,
27                           curl_off_t *timep);
28~~~
29
30# DESCRIPTION
31
32Pass a pointer to a curl_off_t to receive the time, in microseconds,
33it took from the
34start until the first byte is received by libcurl. This includes
35CURLINFO_PRETRANSFER_TIME_T(3) and also the time the server needs to
36calculate the result.
37
38When a redirect is followed, the time from each request is added together.
39
40See also the TIMES overview in the curl_easy_getinfo(3) man page.
41
42# %PROTOCOLS%
43
44# EXAMPLE
45
46~~~c
47int main(void)
48{
49  CURL *curl = curl_easy_init();
50  if(curl) {
51    CURLcode res;
52    curl_off_t start;
53    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
54    res = curl_easy_perform(curl);
55    if(CURLE_OK == res) {
56      res = curl_easy_getinfo(curl, CURLINFO_STARTTRANSFER_TIME_T, &start);
57      if(CURLE_OK == res) {
58        printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", start / 1000000,
59               (long)(start % 1000000));
60      }
61    }
62    /* always cleanup */
63    curl_easy_cleanup(curl);
64  }
65}
66~~~
67
68# %AVAILABILITY%
69
70# RETURN VALUE
71
72Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
73