Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_REDIRECT_TIME.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, 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_REDIRECT_TIME 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
24
25 .SH NAME
26 CURLINFO_REDIRECT_TIME \- get the time for all redirection steps
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_TIME, double *timep);
31 .SH DESCRIPTION
32 Pass a pointer to a double to receive the total time, in seconds, it took for
33 all redirection steps include name lookup, connect, pretransfer and transfer
34 before final transaction was started. CURLINFO_REDIRECT_TIME contains the
35 complete execution time for multiple redirections.
36
37 See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
38 .SH PROTOCOLS
39 All
40 .SH EXAMPLE
41 .nf
42 curl = curl_easy_init();
43 if(curl) {
44   double redirect;
45   curl_easy_setopt(curl, CURLOPT_URL, url);
46   res = curl_easy_perform(curl);
47   if(CURLE_OK == res) {
48     res = curl_easy_getinfo(curl, CURLINFO_REDIRECT_TIME, &redirect);
49     if(CURLE_OK == res) {
50       printf("Time: %.1f", redirect);
51     }
52   }
53   /* always cleanup */
54   curl_easy_cleanup(curl);
55 }
56 .fi
57 .SH AVAILABILITY
58 Added in 7.9.7
59 .SH RETURN VALUE
60 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
61 .SH "SEE ALSO"
62 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "