1---
2c: Copyright (C) Daniel Stenberg, <daniel.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)
12---
13
14# NAME
15
16CURLINFO_QUEUE_TIME_T - time this transfer was queued
17
18# SYNOPSIS
19
20~~~c
21#include <curl/curl.h>
22
23CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_QUEUE_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, this
30transfer was held in a waiting queue before it started "for real". A transfer
31might be put in a queue if after getting started, it cannot create a new
32connection etc due to set conditions and limits imposed by the application.
33
34See also the TIMES overview in the curl_easy_getinfo(3) man page.
35
36# PROTOCOLS
37
38All
39
40# EXAMPLE
41
42~~~c
43int main(void)
44{
45  CURL *curl = curl_easy_init();
46  if(curl) {
47    CURLcode res;
48    curl_off_t queue;
49    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
50    res = curl_easy_perform(curl);
51    if(CURLE_OK == res) {
52      res = curl_easy_getinfo(curl, CURLINFO_QUEUE_TIME_T, &queue);
53      if(CURLE_OK == res) {
54        printf("Queued: %" CURL_FORMAT_CURL_OFF_T ".%06ld us", queue / 1000000,
55               (long)(queue % 1000000));
56      }
57    }
58    /* always cleanup */
59    curl_easy_cleanup(curl);
60  }
61}
62~~~
63
64# AVAILABILITY
65
66Added in 8.6.0
67
68# RETURN VALUE
69
70Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
71