php-task
diff --git a/‎index.rst‎
Lines changed: 1 addition & 0 deletions b/‎index.rst‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎retry.rst‎
Lines changed: 41 additions & 0 deletions b/‎retry.rst‎
Lines changed: 41 additions & 0 deletions
@@ -31,6 +31,7 @@ Contents
 
     components
     locking
+    retry
     quick-example
     symfony
 
 
@@ -0,0 +1,41 @@
+Retry
+=====
+Some of the tasks which will be executed by a handler are risky and could fail
+(e.g. long running, i/o ...). To allow retry of this tasks the handler is able
+to implement the interface ``RetryTaskHandlerInterface`` and specify a maximum
+amount of attempts to pass the task.
+
+The retries will be scheduled as soon as possible and the following tasks will
+be scheduled after this retry later. This prevent the following tasks to fail
+because of bad starting conditions because of the previous task.
+
+Example
+*******
+
+.. code-block:: php
+
+    <?php
+
+    include __DIR__ . '/vendor/autoload.php';
+
+    class ImageResizeHandler implements Task\Handler\TaskHandlerInterface, Task\Executor\RetryTaskHandlerInterface
+    {
+        public function handle($workload)
+        {
+            try {
+                $this->doSomething();
+            } catch (SpecificException $exception) {
+                throw new FailedException($exception);
+            }
+
+            // other exceptions will be propagated to the runner
+            // the runner will retry the execution until the max-attempts are reached
+        }
+
+        public function getMaximumAttempts()
+        {
+            return 3;
+        }
+    }
+
+
-Original file line number
+Diff line change
@@ @@ -31,6 +31,7 @@ Contents @@
     components
     locking
 +    retry
     quick-example
     symfony