1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_QUEUE_TIME_T
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: 8.6.0
15---
16
17# NAME
18
19CURLINFO_QUEUE_TIME_T - time this transfer was queued
20
21# SYNOPSIS
22
23~~~c
24#include <curl/curl.h>
25
26CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_QUEUE_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, this
33transfer was held in a waiting queue before it started "for real". A transfer
34might be put in a queue if after getting started, it cannot create a new
35connection etc due to set conditions and limits imposed by the application.
36
37See also the TIMES overview in the curl_easy_getinfo(3) man page.
38
39# %PROTOCOLS%
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 queue;
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_QUEUE_TIME_T, &queue);
54      if(CURLE_OK == res) {
55        printf("Queued: %" CURL_FORMAT_CURL_OFF_T ".%06ld us", queue / 1000000,
56               (long)(queue % 1000000));
57      }
58    }
59    /* always cleanup */
60    curl_easy_cleanup(curl);
61  }
62}
63~~~
64
65# %AVAILABILITY%
66
67# RETURN VALUE
68
69Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
70