| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 |
- .\" generated by cd2nroff 0.1 from CURLINFO_QUEUE_TIME_T.md
- .TH CURLINFO_QUEUE_TIME_T 3 "2025-01-17" libcurl
- .SH NAME
- CURLINFO_QUEUE_TIME_T \- time this transfer was queued
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_QUEUE_TIME_T,
- curl_off_t *timep);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a curl_off_t to receive the time, in microseconds, this
- transfer was held in a waiting queue before it started "for real". A transfer
- might be put in a queue if after getting started, it cannot create a new
- connection etc due to set conditions and limits imposed by the application.
- See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode res;
- curl_off_t queue;
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
- res = curl_easy_perform(curl);
- if(CURLE_OK == res) {
- res = curl_easy_getinfo(curl, CURLINFO_QUEUE_TIME_T, &queue);
- if(CURLE_OK == res) {
- printf("Queued: %" CURL_FORMAT_CURL_OFF_T ".%06ld us", queue / 1000000,
- (long)(queue % 1000000));
- }
- }
- /* always cleanup */
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 8.6.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLINFO_STARTTRANSFER_TIME_T (3),
- .BR CURLOPT_TIMEOUT (3),
- .BR curl_easy_getinfo (3),
- .BR curl_easy_setopt (3)
|