iw7-mod/deps/curl/docs/libcurl/opts/CURLINFO_SPEED_DOWNLOAD_T.md
2024-08-13 05:15:34 -04:00

1.2 KiB

c SPDX-License-Identifier Title Section Source See-also
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLINFO_SPEED_DOWNLOAD_T 3 libcurl
CURLINFO_SIZE_UPLOAD_T (3)
CURLINFO_SPEED_UPLOAD_T (3)
curl_easy_getinfo (3)
curl_easy_setopt (3)

NAME

CURLINFO_SPEED_DOWNLOAD_T - get download speed

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T,
                           curl_off_t *speed);

DESCRIPTION

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

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) {
      curl_off_t speed;
      res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD_T, &speed);
      if(!res) {
        printf("Download speed %" CURL_FORMAT_CURL_OFF_T " bytes/sec\n",
               speed);
      }
    }
  }
}

AVAILABILITY

Added in 7.55.0

RETURN VALUE

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