Return to CURLINFO_RETRY_AFTER.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_RETRY_AFTER.3, revision 1.1.1.1

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