Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_PRETRANSFER_TIME.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLINFO_PRETRANSFER_TIME 3 "August 26, 2019" "libcurl 7.70.0" "curl_easy_getinfo options"
24:
25: .SH NAME
26: CURLINFO_PRETRANSFER_TIME \- get the time until the file transfer start
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME, double *timep);
31: .SH DESCRIPTION
32: Pass a pointer to a double to receive the time, in seconds, it took from the
33: start until the file transfer is just about to begin. This includes all
34: pre-transfer commands and negotiations that are specific to the particular
35: protocol(s) involved. It does \fInot\fP involve the sending of the protocol-
36: specific request that triggers a transfer.
37:
38: When a redirect is followed, the time from each request is added together.
39:
40: See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
41: .SH PROTOCOLS
42: All
43: .SH EXAMPLE
44: .nf
45: curl = curl_easy_init();
46: if(curl) {
47: double pretransfer;
48: curl_easy_setopt(curl, CURLOPT_URL, url);
49: res = curl_easy_perform(curl);
50: if(CURLE_OK == res) {
51: res = curl_easy_getinfo(curl, CURLINFO_PRETRANSFER_TIME, &pretransfer);
52: if(CURLE_OK == res) {
53: printf("Time: %.1f", pretransfer);
54: }
55: }
56: /* always cleanup */
57: curl_easy_cleanup(curl);
58: }
59: .fi
60: .SH AVAILABILITY
61: Added in 7.4.1
62: .SH RETURN VALUE
63: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
64: .SH "SEE ALSO"
65: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " CURLINFO_PRETRANSFER_TIME_T "(3)"
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>