curl / libcurl / API / curl_easy_getinfo / CURLINFO_SPEED_DOWNLOAD

CURLINFO_SPEED_DOWNLOAD explained

Name

CURLINFO_SPEED_DOWNLOAD - get download speed

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD,
                           double *speed);

Description

Pass a pointer to a double to receive the average download speed that curl measured for the complete download. Measured in bytes/second.

CURLINFO_SPEED_DOWNLOAD_T is a newer replacement that returns a more sensible variable type.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
 
    /* Perform the request */
    res = curl_easy_perform(curl);
 
    if(!res) {
      double speed;
      res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD, &speed);
      if(!res) {
        printf("Download speed %.0f bytes/sec\n", speed);
      }
    }
  }
}

Deprecated

Deprecated since 7.55.0.

Availability

Added in curl 7.4.1

Return value

curl_easy_getinfo returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.