| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. |
| .\" * |
| .\" * This software is licensed as described in the file COPYING, which |
| .\" * you should have received as part of this distribution. The terms |
| .\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| .\" * |
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| .\" * copies of the Software, and permit persons to whom the Software is |
| .\" * furnished to do so, under the terms of the COPYING file. |
| .\" * |
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| .\" * KIND, either express or implied. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLINFO_SPEED_DOWNLOAD_T 3 "September 16, 2020" "libcurl 7.73.0" "curl_easy_getinfo options" |
| |
| .SH NAME |
| CURLINFO_SPEED_DOWNLOAD_T \- get download speed |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T, curl_off_t *speed); |
| .SH DESCRIPTION |
| Pass a pointer to a \fIcurl_off_t\fP to receive the average download speed |
| that curl measured for the complete download. Measured in bytes/second. |
| .SH PROTOCOLS |
| .SH EXAMPLE |
| .nf |
| CURL *curl = curl_easy_init(); |
| if(curl) { |
| 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); |
| } |
| } |
| } |
| .fi |
| .SH AVAILABILITY |
| Added in 7.55.0 |
| .SH RETURN VALUE |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| .SH "SEE ALSO" |
| .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " |
| .BR CURLINFO_SPEED_UPLOAD "(3), " |
| .BR CURLINFO_SIZE_UPLOAD_T "(3), " |
