Damien Krotkine > Action-Retry-0.10 > Action::Retry



Annotate this POD

View/Report Bugs
Module Version: 0.10   Source   Latest Release: Action-Retry-0.24


Action::Retry - Module to try to perform an action, with various ways of retrying and sleeping between retries.


version 0.10


  use Action::Retry;
  my $action = Action::Retry->new(
    attempt_code => sub { ... },
    strategy => 'Linear',



  ro, CodeRef, required

The code to run to attempt doing the action. Will be evaluated taking care of the caller's context.


  ro, CodeRef

The code to run to check if we need to retry the action. It will be given as first argument, $@, then as following arguments the return values of the execution of attempt_code.

True return value means the execution of attempt_code was a failure and it needs to be retried. False means it went well.

Defaults to:

  # Returns true if there were an exception evaluating to something true
  sub { $_[0] }


  ro, CodeRef, optional

If given, the code to run when retries are given up.


The strategy for managing retrying times, sleeping, and giving up. It must be an object that does the Action::Retry::Strategy role.

This attribute has a coercion from strings and hashrefs. If you pass a string, it will be treated as a class name (under Action::Retry::Strategy::, unless it is prefxed with a +) to instantiate.

If you pass a hashref, the first key will be treated as a class name as above, and the value of that key will be treated as the args to pass to new.

Some existing stragies classes are Action::Retry::Strategy::Constant, Action::Retry::Strategy::Fibonacci, Action::Retry::Strategy::Linear.


  ro, defaults to 0

If true, the instance will be in a pseudo non blocking mode. In this mode, the run() function behaves a bit differently: instead of sleeping between retries, the run() command will immediately return. Subsequent call to run() will immediately return, until the time to sleep has been elapsed. This allows to do things like that:

  my $action = Action::Retry( ... , non_blocking => 1 );
  while (1) {
    # if the action failed, it doesn't sleep
    # next time it's called, it won't do anything until it's time to retry
    # do something else while time goes on

If you need a more advanced non blocking mode and callbacks, then look at AnyEvent::Retry



Does the following:

step 1

Runs the attempt_code CodeRef in the proper context in an eval {} block, saving $@ in $error.

step 2

Runs the retry_if_code CodeRef in scalar context, giving it as arguments $error, and the return values of attempt_code. If it returns true, we consider that it was a failure, and move to step 3. Otherwise, we consider it means success, and return the return values of attempt_code.

step 3

Ask the strategy if it's still useful to retry. If yes, sleep accordingly, and go back to step 2. If not, go to step 4.

step 4

Runs the on_failure_code CodeRef in the proper context, giving it as arguments $error, and the return values of attempt_code, and returns the results back to the caller.

I created this module because the other related modules I found didn't exactly do what I wanted. Here is the list and why:


No custom checking code. No retry strategies. Can't sleep under one second. No non-blocking mode. No custom failure code.


No retry strategies. Can't sleep under one second. Retry code is passed the results of the attempt code, but not the exception. No non-blocking mode. No custom failure code.


No custom checking code. Strange exception catching behavior. No retry strategies. No non-blocking mode. No custom failure code.


Depends on AnyEvent, and Moose. Strategies are less flexibles, and they don't have sleep timeouts (only max tries).


Damien "dams" Krotkine


This software is copyright (c) 2013 by Damien "dams" Krotkine.

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

syntax highlighting: