CURLINFO_STARTTRANSFER_TIME.md (1623B)
1 --- 2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 SPDX-License-Identifier: curl 4 Title: CURLINFO_STARTTRANSFER_TIME 5 Section: 3 6 Source: libcurl 7 See-also: 8 - CURLINFO_STARTTRANSFER_TIME_T (3) 9 - CURLOPT_TIMEOUT (3) 10 - curl_easy_getinfo (3) 11 - curl_easy_setopt (3) 12 Protocol: 13 - All 14 Added-in: 7.9.2 15 --- 16 17 # NAME 18 19 CURLINFO_STARTTRANSFER_TIME - get the time until the first byte is received 20 21 # SYNOPSIS 22 23 ~~~c 24 #include <curl/curl.h> 25 26 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_STARTTRANSFER_TIME, 27 double *timep); 28 ~~~ 29 30 # DESCRIPTION 31 32 Pass a pointer to a double to receive the time, in seconds, it took from the 33 start until the first byte is received by libcurl. This includes 34 CURLINFO_PRETRANSFER_TIME(3) and also the time the server needs to 35 calculate the result. 36 37 When a redirect is followed, the time from each request is added together. 38 39 See also the TIMES overview in the curl_easy_getinfo(3) man page. 40 41 # %PROTOCOLS% 42 43 # EXAMPLE 44 45 ~~~c 46 int main(void) 47 { 48 CURL *curl = curl_easy_init(); 49 if(curl) { 50 CURLcode res; 51 double start; 52 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); 53 res = curl_easy_perform(curl); 54 if(CURLE_OK == res) { 55 res = curl_easy_getinfo(curl, CURLINFO_STARTTRANSFER_TIME, &start); 56 if(CURLE_OK == res) { 57 printf("Time: %.1f", start); 58 } 59 } 60 /* always cleanup */ 61 curl_easy_cleanup(curl); 62 } 63 } 64 ~~~ 65 66 # %AVAILABILITY% 67 68 # RETURN VALUE 69 70 curl_easy_getinfo(3) returns a CURLcode indicating success or error. 71 72 CURLE_OK (0) means everything was OK, non-zero means an error occurred, see 73 libcurl-errors(3).