CURLINFO_SPEED_DOWNLOAD_T.md (1384B)
1 --- 2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 SPDX-License-Identifier: curl 4 Title: CURLINFO_SPEED_DOWNLOAD_T 5 Section: 3 6 Source: libcurl 7 See-also: 8 - CURLINFO_SIZE_UPLOAD_T (3) 9 - CURLINFO_SPEED_UPLOAD_T (3) 10 - curl_easy_getinfo (3) 11 - curl_easy_setopt (3) 12 Protocol: 13 - All 14 Added-in: 7.55.0 15 --- 16 17 # NAME 18 19 CURLINFO_SPEED_DOWNLOAD_T - get download speed 20 21 # SYNOPSIS 22 23 ~~~c 24 #include <curl/curl.h> 25 26 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T, 27 curl_off_t *speed); 28 ~~~ 29 30 # DESCRIPTION 31 32 Pass a pointer to a *curl_off_t* to receive the average download speed 33 that curl measured for the complete download. Measured in bytes/second. 34 35 # %PROTOCOLS% 36 37 # EXAMPLE 38 39 ~~~c 40 int main(void) 41 { 42 CURL *curl = curl_easy_init(); 43 if(curl) { 44 CURLcode res; 45 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); 46 47 /* Perform the request */ 48 res = curl_easy_perform(curl); 49 50 if(!res) { 51 curl_off_t speed; 52 res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD_T, &speed); 53 if(!res) { 54 printf("Download speed %" CURL_FORMAT_CURL_OFF_T " bytes/sec\n", 55 speed); 56 } 57 } 58 } 59 } 60 ~~~ 61 62 # %AVAILABILITY% 63 64 # RETURN VALUE 65 66 curl_easy_getinfo(3) returns a CURLcode indicating success or error. 67 68 CURLE_OK (0) means everything was OK, non-zero means an error occurred, see 69 libcurl-errors(3).