mirror of
https://codeberg.org/kiss-community/repo
synced 2025-01-05 01:10:07 -07:00
51 lines
1.5 KiB
Groff
51 lines
1.5 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLINFO_RETRY_AFTER.md
|
|
.TH CURLINFO_RETRY_AFTER 3 "2024-11-09" libcurl
|
|
.SH NAME
|
|
CURLINFO_RETRY_AFTER \- returns the Retry\-After retry delay
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RETRY_AFTER,
|
|
curl_off_t *retry);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a curl_off_t variable to receive the number of seconds the
|
|
HTTP server suggests the client should wait until the next request is
|
|
issued. The information from the "Retry\-After:" header.
|
|
|
|
While the HTTP header might contain a fixed date string, the
|
|
\fICURLINFO_RETRY_AFTER(3)\fP always returns the number of seconds to wait \-
|
|
or zero if there was no header or the header could not be parsed.
|
|
.SH DEFAULT
|
|
Zero if there was no header.
|
|
.SH PROTOCOLS
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
res = curl_easy_perform(curl);
|
|
if(res == CURLE_OK) {
|
|
curl_off_t wait = 0;
|
|
curl_easy_getinfo(curl, CURLINFO_RETRY_AFTER, &wait);
|
|
if(wait)
|
|
printf("Wait for %" CURL_FORMAT_CURL_OFF_T " seconds\\n", wait);
|
|
}
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.66.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_HEADERFUNCTION (3),
|
|
.BR CURLOPT_STDERR (3),
|
|
.BR curl_easy_header (3)
|