.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::Twitter::Role::RetryOnError 3pm"
.TH Net::Twitter::Role::RetryOnError 3pm "2018-01-18" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Twitter::Role::RetryOnError \- Retry Twitter API calls on error
.SH "VERSION"
.IX Header "VERSION"
version 4.01043
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    use Net::Twitter;
\&    $nt = Net::Twitter\->new(
\&        traits      => [\*(AqAPI::RESTv1_1\*(Aq, \*(AqRetryOnError\*(Aq]
\&        max_retries => 3,
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Temporary errors are not uncommon when calling the Twitter \s-1API.\s0  When applied
to Net::Twitter this role will provide automatic retries of \s-1API\s0 calls in a very
configurable way.
.PP
It only retries when the response status code is >= 500.  Other error codes
indicate a permanent error.  If the maximum number of retries is reached,
without success, an exception is thrown, as usual.
.SH "OPTIONS"
.IX Header "OPTIONS"
This role adds the following options to \f(CW\*(C`new\*(C'\fR:
.IP "initial_retry_delay" 4
.IX Item "initial_retry_delay"
A floating point number specifying the initial delay, after an error, before
retrying.  Default: 0.25 (250 milliseconds).
.IP "max_retry_delay" 4
.IX Item "max_retry_delay"
A floating point number specifying the maximum delay between retries.  Default: 4.0
.IP "retry_delay_multiplier" 4
.IX Item "retry_delay_multiplier"
On the second and subsequent retries, a new delay is calculated by multiplying the previous
delay by \f(CW\*(C`retry_delay_multiplier\*(C'\fR. Default: 2.0
.IP "max_retries" 4
.IX Item "max_retries"
The maximum number of consecutive retries before giving up and throwing an exception.
If set to 0, it the \s-1API\s0 call will be retried indefinitely. Default 5.
.IP "retry_delay_code" 4
.IX Item "retry_delay_code"
A code reference that will be called to handle the delay.  It is passed a
single argument: a floating point number specifying the number of seconds to
delay.  By default, \*(L"sleep\*(R" in Time::HiRes is called.
.Sp
If you're using a non-blocking user agent, like Coro::LWP, you should use
this option to provide a non-blocking delay.
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Mims <marc@questright.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2016 Marc Mims
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software and may be distributed under the same terms as perl itself.