mirror of
https://codeberg.org/kiss-community/repo
synced 2024-12-23 07:40:11 -07:00
55 lines
1.6 KiB
Groff
55 lines
1.6 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLINFO_PRETRANSFER_TIME.md
|
|
.TH CURLINFO_PRETRANSFER_TIME 3 "2024-08-02" libcurl
|
|
.SH NAME
|
|
CURLINFO_PRETRANSFER_TIME \- get the time until the file transfer start
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME,
|
|
double *timep);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a double to receive the time, in seconds, it took from the
|
|
start until the file transfer is just about to begin.
|
|
|
|
This time\-stamp includes all pre\-transfer commands and negotiations that are
|
|
specific to the particular protocol(s) involved. It includes the sending of
|
|
the protocol\-specific instructions that trigger a transfer.
|
|
|
|
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
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
double pretransfer;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
res = curl_easy_perform(curl);
|
|
if(CURLE_OK == res) {
|
|
res = curl_easy_getinfo(curl, CURLINFO_PRETRANSFER_TIME, &pretransfer);
|
|
if(CURLE_OK == res) {
|
|
printf("Time: %.1f", pretransfer);
|
|
}
|
|
}
|
|
/* always cleanup */
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.4.1
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLINFO_CONNECT_TIME_T (3),
|
|
.BR CURLINFO_PRETRANSFER_TIME_T (3),
|
|
.BR curl_easy_getinfo (3),
|
|
.BR curl_easy_setopt (3)
|