CURLINFO_PRETRANSFER_TIME_T(3) Library Functions Manual
NAME
CURLINFO_PRETRANSFER_TIME_T - get the time until the file transfer
start
SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME_T,
curl_off_t *timep);
DESCRIPTION
Pass a pointer to a curl_off_t to receive the time, in microseconds, 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 curl_easy_getinfo(3) man page.
PROTOCOLS
This functionality affects all supported protocols
EXAMPLE
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_off_t 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_T, &pretransfer);
if(CURLE_OK == res) {
printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld\n",
pretransfer / 1000000,
(long)(pretransfer % 1000000));
}
}
/* always cleanup */
curl_easy_cleanup(curl);
}
}
AVAILABILITY
Added in curl 7.61.0
RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION
if not.
SEE ALSO
CURLINFO_PRETRANSFER_TIME_T(3),
curl_easy_getinfo(3), curl_easy_setopt(3)
libcurl 2024-08-05 CURLINFO_PRETRANSFER_TIME_T(3)
curl 8.9.1 - Generated Tue Aug 13 16:34:04 CDT 2024