Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLINFO_RETRY_AFTER.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, 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_RETRY_AFTER 3 "6 Aug 2019" "libcurl 7.66.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_RETRY_AFTER \- returns the Retry-After retry delay
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RETRY_AFTER, curl_off_t *retry);
30 .SH DESCRIPTION
31 Pass a pointer to a curl_off_t variable to receive the number of seconds the
32 HTTP server suggesets the client should wait until the next request is
33 issued. The information from the "Retry-After:" header.
34
35 While the HTTP header might contain a fixed date string, the
36 \fICURLINFO_RETRY_AFTER(3)\fP will always return number of seconds to wait -
37 or zero if there was no header or the header couldn't be parsed.
38 .SH DEFAULT
39 Returns zero delay if there was no header.
40 .SH PROTOCOLS
41 HTTP(S)
42 .SH EXAMPLE
43 .nf
44 CURL *curl = curl_easy_init();
45 if(curl) {
46 CURLcode res;
47 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
48 res = curl_easy_perform(curl);
49 if(res == CURLE_OK) {
50 curl_off_t wait = 0;
51 curl_easy_getinfo(curl, CURLINFO_RETRY_AFTER, &wait);
52 if(wait)
53 printf("Wait for %" CURL_FORMAT_CURL_OFF_T " seconds\\n", wait);
54 }
55 curl_easy_cleanup(curl);
56 }
57 .fi
58 .SH AVAILABILITY
59 Added in curl 7.66.0
60 .SH RETURN VALUE
61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
62 .SH "SEE ALSO"
63 .BR CURLOPT_STDERR "(3), " CURLOPT_HEADERFUNCTION "(3), "