2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLINFO_SPEED_DOWNLOAD.md
|
2024-08-02 19:52:59 -06:00
|
|
|
.TH CURLINFO_SPEED_DOWNLOAD 3 "2024-08-02" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLINFO_SPEED_DOWNLOAD \- get download speed
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD,
|
|
|
|
|
double *speed);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a pointer to a double to receive the average download speed that curl
|
|
|
|
|
measured for the complete download. Measured in bytes/second.
|
|
|
|
|
|
|
|
|
|
\fICURLINFO_SPEED_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
|
|
|
|
|
sensible variable type.
|
|
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects all supported protocols
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
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);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
2024-07-29 18:00:04 -06:00
|
|
|
.SH DEPRECATED
|
|
|
|
|
Deprecated since 7.55.0.
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.4.1
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLINFO_SIZE_UPLOAD_T (3),
|
|
|
|
|
.BR CURLINFO_SPEED_UPLOAD (3),
|
|
|
|
|
.BR curl_easy_getinfo (3),
|
|
|
|
|
.BR curl_easy_setopt (3)
|
