File: README.md

Recommend this page to a friend!
  Classes of Omar Shaban  >  Resilient PHP Task Runner  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Resilient PHP Task Runner
Run a task and retry while it fails for a period
Author: By
Last change:
Date: 1 month ago
Size: 2,051 bytes
 

Contents

Class file image Download

Resilient Task

Build Status CodeCov Release PHPv Downloads

Resilient Task Runner, A circuit breaker implementation, highly configurable task runner with number of max retries, back-off factor, maximum sleep time, and starting sleep time.

Usage

Install the `eshta/resilient-task` package:

$ composer require eshta/resilient-task

Example

use GuzzleHttp\Exception\ConnectException;


$task = function() {
    try {
        $response = $client->request('GET', 'https://github.com/_abc_123_404');

        return $response;
    } catch (ConnectException $e) {
        echo Psr7\str($e->getRequest());
    }
};

$runner = new ResilientTaskRunner(10, 16, 0.5);
$response = $runner->run($task);

if (is_null($response)) {
    throw new MyFavouriteException('Service call failed!');
}
  • try 10 times at most
  • maximum sleep time between retries 16 seconds
  • first sleep time is half a second
  • back-off factor [2 default]: double sleeping time after each failed attempt

Note:: the runner will only stop when there is a non-null result returned by the task, or the max tries have been exhausted

Contributing

See CONTRIBUTING and Code of Conduct, if you want to make contribution (pull request) or just build and test project on your own.

Resources


For more information send a message to info at phpclasses dot org.