CURLINFO_SPEED_DOWNLOAD.3 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. .\" generated by cd2nroff 0.1 from CURLINFO_SPEED_DOWNLOAD.md
  2. .TH CURLINFO_SPEED_DOWNLOAD 3 "2025-01-17" libcurl
  3. .SH NAME
  4. CURLINFO_SPEED_DOWNLOAD \- get download speed
  5. .SH SYNOPSIS
  6. .nf
  7. #include <curl/curl.h>
  8. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD,
  9. double *speed);
  10. .fi
  11. .SH DESCRIPTION
  12. Pass a pointer to a double to receive the average download speed that curl
  13. measured for the complete download. Measured in bytes/second.
  14. \fICURLINFO_SPEED_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
  15. sensible variable type.
  16. .SH PROTOCOLS
  17. This functionality affects all supported protocols
  18. .SH EXAMPLE
  19. .nf
  20. int main(void)
  21. {
  22. CURL *curl = curl_easy_init();
  23. if(curl) {
  24. CURLcode res;
  25. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  26. /* Perform the request */
  27. res = curl_easy_perform(curl);
  28. if(!res) {
  29. double speed;
  30. res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD, &speed);
  31. if(!res) {
  32. printf("Download speed %.0f bytes/sec\\n", speed);
  33. }
  34. }
  35. }
  36. }
  37. .fi
  38. .SH DEPRECATED
  39. Deprecated since 7.55.0.
  40. .SH AVAILABILITY
  41. Added in curl 7.4.1
  42. .SH RETURN VALUE
  43. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  44. .SH SEE ALSO
  45. .BR CURLINFO_SIZE_UPLOAD_T (3),
  46. .BR CURLINFO_SPEED_UPLOAD (3),
  47. .BR curl_easy_getinfo (3),
  48. .BR curl_easy_setopt (3)