CURLINFO_QUEUE_TIME_T.md (1669B)
1 --- 2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 SPDX-License-Identifier: curl 4 Title: CURLINFO_QUEUE_TIME_T 5 Section: 3 6 Source: libcurl 7 See-also: 8 - CURLINFO_STARTTRANSFER_TIME_T (3) 9 - CURLOPT_TIMEOUT (3) 10 - curl_easy_getinfo (3) 11 - curl_easy_setopt (3) 12 Protocol: 13 - All 14 Added-in: 8.6.0 15 --- 16 17 # NAME 18 19 CURLINFO_QUEUE_TIME_T - time this transfer was queued 20 21 # SYNOPSIS 22 23 ~~~c 24 #include <curl/curl.h> 25 26 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_QUEUE_TIME_T, 27 curl_off_t *timep); 28 ~~~ 29 30 # DESCRIPTION 31 32 Pass a pointer to a curl_off_t to receive the time, in microseconds, this 33 transfer was held in a waiting queue before it started "for real". A transfer 34 might be put in a queue if after getting started, it cannot create a new 35 connection etc due to set conditions and limits imposed by the application. 36 37 See also the TIMES overview in the curl_easy_getinfo(3) man page. 38 39 # %PROTOCOLS% 40 41 # EXAMPLE 42 43 ~~~c 44 int 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 69 curl_easy_getinfo(3) returns a CURLcode indicating success or error. 70 71 CURLE_OK (0) means everything was OK, non-zero means an error occurred, see 72 libcurl-errors(3).