|
@@ -0,0 +1,74 @@
|
|
|
+.\" **************************************************************************
|
|
|
+.\" * _ _ ____ _
|
|
|
+.\" * Project ___| | | | _ \| |
|
|
|
+.\" * / __| | | | |_) | |
|
|
|
+.\" * | (__| |_| | _ <| |___
|
|
|
+.\" * \___|\___/|_| \_\_____|
|
|
|
+.\" *
|
|
|
+.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
+.\" *
|
|
|
+.\" * This software is licensed as described in the file COPYING, which
|
|
|
+.\" * you should have received as part of this distribution. The terms
|
|
|
+.\" * are also available at https://curl.se/docs/copyright.html.
|
|
|
+.\" *
|
|
|
+.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
|
+.\" * copies of the Software, and permit persons to whom the Software is
|
|
|
+.\" * furnished to do so, under the terms of the COPYING file.
|
|
|
+.\" *
|
|
|
+.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
|
+.\" * KIND, either express or implied.
|
|
|
+.\" *
|
|
|
+.\" * SPDX-License-Identifier: curl
|
|
|
+.\" *
|
|
|
+.\" **************************************************************************
|
|
|
+.\"
|
|
|
+.TH CURLINFO_QUEUE_TIME_T 3 "28 Apr 2018" libcurl 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
|
|
|
+All
|
|
|
+.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 8.6.0
|
|
|
+.SH RETURN VALUE
|
|
|
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
|
+.SH "SEE ALSO"
|
|
|
+.BR curl_easy_getinfo (3),
|
|
|
+.BR curl_easy_setopt (3),
|
|
|
+.BR CURLINFO_STARTTRANSFER_TIME_T (3),
|
|
|
+.BR CURLOPT_TIMEOUT (3)
|