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