| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 2018 - 2019, 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_PRETRANSFER_TIME_T 3 "August 26, 2019" "libcurl 7.70.0" "curl_easy_getinfo options" |
| |
| .SH NAME |
| CURLINFO_PRETRANSFER_TIME_T \- get the time until the file transfer start |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME_T, curl_off_t *timep); |
| .SH DESCRIPTION |
| Pass a pointer to a curl_off_t to receive the time, in microseconds, |
| it took from the |
| start until the file transfer is just about to begin. This includes all |
| pre-transfer commands and negotiations that are specific to the particular |
| protocol(s) involved. It does \fInot\fP involve the sending of the protocol- |
| specific request that triggers a transfer. |
| |
| When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page. |
| .SH PROTOCOLS |
| All |
| .SH EXAMPLE |
| .nf |
| curl = curl_easy_init(); |
| if(curl) { |
| curl_off_t pretransfer; |
| curl_easy_setopt(curl, CURLOPT_URL, url); |
| res = curl_easy_perform(curl); |
| if(CURLE_OK == res) { |
| res = curl_easy_getinfo(curl, CURLINFO_PRETRANSFER_TIME_T, &pretransfer); |
| if(CURLE_OK == res) { |
| printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", pretransfer / 1000000, |
| (long)(pretransfer % 1000000)); |
| } |
| } |
| /* always cleanup */ |
| curl_easy_cleanup(curl); |
| } |
| .fi |
| .SH AVAILABILITY |
| Added in 7.61.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), " CURLINFO_PRETRANSFER_TIME "(3)" |
