The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Algorithm-Retry-0.001
++
/ Algorithm::Retry::Constant

NAME

Algorithm::Retry::Constant - Retry using a constant wait time

VERSION

This document describes version 0.001 of Algorithm::Retry::Constant (from Perl distribution Algorithm-Retry), released on 2019-04-08.

SYNOPSIS

 use Algorithm::Retry::Constant;

 # 1. instantiate

 my $ar = Algorithm::Retry::Constant->new(
     #max_attempts     => 0, # optional, default 0 (retry endlessly)
     #jitter_factor    => 0, # optional, set to positive value to add randomness
     delay_on_failure  => 2, # required
     #delay_on_success => 0, # optional, default 0
 );

 # 2. log success/failure and get a new number of seconds to delay, timestamp is
 # optional argument (default is current time) but must be monotonically
 # increasing.

 my $secs = $ar->failure(1554652553); # => 2
 my $secs = $ar->success();           # => 0
 my $secs = $ar->failure();           # => 2

DESCRIPTION

This retry strategy is one of the simplest: it waits X second(s) after each failure, or Y second(s) (default 0) after a success. Some randomness can be introduced to avoid "thundering herd problem".

METHODS

new

Usage:

 new(%args) -> obj

This function is not exported.

Arguments ('*' denotes required arguments):

  • delay_on_failure* => ufloat

    Number of seconds to wait after a failure.

  • delay_on_success => ufloat (default: 0)

    Number of seconds to wait after a success.

  • jitter_factor => float

    How much to add randomness.

    If you set this to a value larger than 0, the actual delay will be between a random number between original_delay * (1-jitter_factor) and original_delay * (1+jitter_factor). Jitters are usually added to avoid so-called "thundering herd" problem.

  • max_attempts => uint (default: 0)

    Maximum number consecutive failures before giving up.

    0 means to retry endlessly without ever giving up. 1 means to give up after a single failure (i.e. no retry attempts). 2 means to retry once after a failure. Note that after a success, the number of attempts is reset (as expected). So if max_attempts is 3, and if you fail twice then succeed, then on the next failure the algorithm will retry again for a maximum of 3 times.

Return value: (obj)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Algorithm-Retry.

SOURCE

Source repository is at https://github.com/perlancar/perl-Algorithm-Retry.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Algorithm-Retry

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

Algorithm::Retry

Other Algorithm::Retry::* classes.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.