mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
55 lines
1.6 KiB
Groff
55 lines
1.6 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLINFO_STARTTRANSFER_TIME_T.md
|
|
.TH CURLINFO_STARTTRANSFER_TIME_T 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLINFO_STARTTRANSFER_TIME_T \- get the time until the first byte is received
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_STARTTRANSFER_TIME_T,
|
|
curl_off_t *timep);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a curl_off_t to receive the time, in microseconds,
|
|
it took from the
|
|
start until the first byte is received by libcurl. This includes
|
|
\fICURLINFO_PRETRANSFER_TIME_T(3)\fP and also the time the server needs to
|
|
calculate the result.
|
|
|
|
When a redirect is followed, the time from each request is added together.
|
|
|
|
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 start;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
res = curl_easy_perform(curl);
|
|
if(CURLE_OK == res) {
|
|
res = curl_easy_getinfo(curl, CURLINFO_STARTTRANSFER_TIME_T, &start);
|
|
if(CURLE_OK == res) {
|
|
printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", start / 1000000,
|
|
(long)(start % 1000000));
|
|
}
|
|
}
|
|
/* always cleanup */
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.61.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 (3),
|
|
.BR CURLOPT_TIMEOUT (3),
|
|
.BR curl_easy_getinfo (3),
|
|
.BR curl_easy_setopt (3)
|