CURLINFO_PRETRANSFER_TIME_T.md (1877B)
1 --- 2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 SPDX-License-Identifier: curl 4 Title: CURLINFO_PRETRANSFER_TIME_T 5 Section: 3 6 Source: libcurl 7 See-also: 8 - CURLINFO_CONNECT_TIME (3) 9 - CURLINFO_PRETRANSFER_TIME_T (3) 10 - curl_easy_getinfo (3) 11 - curl_easy_setopt (3) 12 Protocol: 13 - All 14 Added-in: 7.61.0 15 --- 16 17 # NAME 18 19 CURLINFO_PRETRANSFER_TIME_T - get the time until the file transfer start 20 21 # SYNOPSIS 22 23 ~~~c 24 #include <curl/curl.h> 25 26 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME_T, 27 curl_off_t *timep); 28 ~~~ 29 30 # DESCRIPTION 31 32 Pass a pointer to a curl_off_t to receive the time, in microseconds, it took 33 from the start until the file transfer is just about to begin. 34 35 This time-stamp includes all pre-transfer commands and negotiations that are 36 specific to the particular protocol(s) involved. It includes the sending of 37 the protocol-specific instructions that trigger a transfer. 38 39 When a redirect is followed, the time from each request is added together. 40 41 See also the TIMES overview in the curl_easy_getinfo(3) man page. 42 43 # %PROTOCOLS% 44 45 # EXAMPLE 46 47 ~~~c 48 int main(void) 49 { 50 CURL *curl = curl_easy_init(); 51 if(curl) { 52 CURLcode res; 53 curl_off_t pretransfer; 54 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); 55 res = curl_easy_perform(curl); 56 if(CURLE_OK == res) { 57 res = curl_easy_getinfo(curl, CURLINFO_PRETRANSFER_TIME_T, &pretransfer); 58 if(CURLE_OK == res) { 59 printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld\n", 60 pretransfer / 1000000, 61 (long)(pretransfer % 1000000)); 62 } 63 } 64 /* always cleanup */ 65 curl_easy_cleanup(curl); 66 } 67 } 68 ~~~ 69 70 # %AVAILABILITY% 71 72 # RETURN VALUE 73 74 curl_easy_getinfo(3) returns a CURLcode indicating success or error. 75 76 CURLE_OK (0) means everything was OK, non-zero means an error occurred, see 77 libcurl-errors(3).