curl / libcurl / API / curl_easy_getinfo / CURLINFO_PRETRANSFER_TIME

CURLINFO_PRETRANSFER_TIME explained

NAME

CURLINFO_PRETRANSFER_TIME - get the time until the file transfer start

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME, double *timep);

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 includes all pre-transfer commands and negotiations that are specific to the particular protocol(s) involved. It does not involve the sending of the protocol- specific request that triggers 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 man page.

PROTOCOLS

All

EXAMPLE

curl = curl_easy_init();
if(curl) {
  double pretransfer;
  curl_easy_setopt(curl, CURLOPT_URL, url);
  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);
}

AVAILABILITY

Added in 7.4.1

RETURN VALUE

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

SEE ALSO

curl_easy_getinfo, curl_easy_setopt, CURLINFO_PRETRANSFER_TIME_T

This HTML page was made with roffit.