deploy: 5fc0cb6

mosquito-cr · Oct 3, 2023 · 4dec0af · 4dec0af
1 parent ad7768f
commit 4dec0af
Show file tree

Hide file tree

Showing 6 changed files with 97 additions and 13 deletions.
diff --git a/Mosquito/Job.html b/Mosquito/Job.html
@@ -454,7 +454,7 @@ <h2>
       </li>
 
       <li class="entry-summary">
-        <a href="#fail%28reason%3D%22%22%29-instance-method" class="signature"><strong>#fail</strong>(reason = <span class="s">&quot;&quot;</span>)</a>
+        <a href="#fail%28reason%3D%22%22%2C%2A%2Cretry%3ABool%3Dtrue%29-instance-method" class="signature"><strong>#fail</strong>(reason = <span class="s">&quot;&quot;</span>, *, retry : Bool = <span class="n">true</span>)</a>
 
           <div class="summary"><p>To be called from inside a #perform Marks this job as a failure.</p></div>
 
@@ -528,6 +528,20 @@ <h2>
 
       </li>
 
+      <li class="entry-summary">
+        <a href="#should_retry%3ABool-instance-method" class="signature"><strong>#should_retry</strong> : Bool</a>
+
+          <div class="summary"><p>When a job run fails, should it be added to the retry queue? See: #fail(retry: false)</p></div>
+
+      </li>
+
+      <li class="entry-summary">
+        <a href="#should_retry%3D%28should_retry%3ABool%29-instance-method" class="signature"><strong>#should_retry=</strong>(should_retry : Bool)</a>
+
+          <div class="summary"><p>When a job run fails, should it be added to the retry queue? See: #fail(retry: false)</p></div>
+
+      </li>
+
       <li class="entry-summary">
         <a href="#state%3AMosquito%3A%3AJob%3A%3AState-instance-method" class="signature"><strong>#state</strong> : Mosquito::Job::State</a>
 
@@ -978,18 +992,18 @@ <h2>
       </div>
     </div>
 
-    <div class="entry-detail" id="fail(reason=&quot;&quot;)-instance-method">
+    <div class="entry-detail" id="fail(reason=&quot;&quot;,*,retry:Bool=true)-instance-method">
       <div class="signature">
 
-        def <strong>fail</strong>(reason = <span class="s">&quot;&quot;</span>)
+        def <strong>fail</strong>(reason = <span class="s">&quot;&quot;</span>, *, retry : Bool = <span class="n">true</span>)
 
-        <a class="method-permalink" href="#fail%28reason%3D%22%22%29-instance-method">#</a>
+        <a class="method-permalink" href="#fail%28reason%3D%22%22%2C%2A%2Cretry%3ABool%3Dtrue%29-instance-method">#</a>
       </div>
 
         <div class="doc">
 
           <p>To be called from inside a #perform
-Marks this job as a failure. If the job is a candidate for
+Marks this job as a failure. By default, if the job is a candidate for
 re-scheduling, it will be run again at a later time.</p>
         </div>
 
@@ -1191,6 +1205,46 @@ <h2>
       </div>
     </div>
 
+    <div class="entry-detail" id="should_retry:Bool-instance-method">
+      <div class="signature">
+
+        def <strong>should_retry</strong> : Bool
+
+        <a class="method-permalink" href="#should_retry%3ABool-instance-method">#</a>
+      </div>
+
+        <div class="doc">
+
+          <p>When a job run fails, should it be added to the retry queue?
+See: #fail(retry: false)</p>
+        </div>
+
+      <br/>
+      <div>
+
+      </div>
+    </div>
+
+    <div class="entry-detail" id="should_retry=(should_retry:Bool)-instance-method">
+      <div class="signature">
+
+        def <strong>should_retry=</strong>(should_retry : Bool)
+
+        <a class="method-permalink" href="#should_retry%3D%28should_retry%3ABool%29-instance-method">#</a>
+      </div>
+
+        <div class="doc">
+
+          <p>When a job run fails, should it be added to the retry queue?
+See: #fail(retry: false)</p>
+        </div>
+
+      <br/>
+      <div>
+
+      </div>
+    </div>
+
     <div class="entry-detail" id="state:Mosquito::Job::State-instance-method">
       <div class="signature">
 

diff --git a/Mosquito/PeriodicJob.html b/Mosquito/PeriodicJob.html
@@ -379,8 +379,8 @@ <h3>Instance methods inherited from class <code><a href="../Mosquito/Job.html">M
     executed?</a>, 
 
 
-    <a href="../Mosquito/Job.html#fail%28reason%3D%22%22%29-instance-method" class="tooltip">
-      <span>fail(reason = <span class="s">&quot;&quot;</span>)</span>
+    <a href="../Mosquito/Job.html#fail%28reason%3D%22%22%2C%2A%2Cretry%3ABool%3Dtrue%29-instance-method" class="tooltip">
+      <span>fail(reason = <span class="s">&quot;&quot;</span>, *, retry : Bool = <span class="n">true</span>)</span>
     fail</a>, 
 
 
@@ -434,6 +434,16 @@ <h3>Instance methods inherited from class <code><a href="../Mosquito/Job.html">M
     run</a>, 
 
 
+    <a href="../Mosquito/Job.html#should_retry%3ABool-instance-method" class="tooltip">
+      <span>should_retry : Bool</span>
+    should_retry</a>, 
+
+
+    <a href="../Mosquito/Job.html#should_retry%3D%28should_retry%3ABool%29-instance-method" class="tooltip">
+      <span>should_retry=(should_retry : Bool)</span>
+    should_retry=</a>, 
+
+
     <a href="../Mosquito/Job.html#state%3AMosquito%3A%3AJob%3A%3AState-instance-method" class="tooltip">
       <span>state : Mosquito::Job::State</span>
     state</a>, 

diff --git a/Mosquito/QueuedJob.html b/Mosquito/QueuedJob.html
@@ -365,8 +365,8 @@ <h3>Instance methods inherited from class <code><a href="../Mosquito/Job.html">M
     executed?</a>, 
 
 
-    <a href="../Mosquito/Job.html#fail%28reason%3D%22%22%29-instance-method" class="tooltip">
-      <span>fail(reason = <span class="s">&quot;&quot;</span>)</span>
+    <a href="../Mosquito/Job.html#fail%28reason%3D%22%22%2C%2A%2Cretry%3ABool%3Dtrue%29-instance-method" class="tooltip">
+      <span>fail(reason = <span class="s">&quot;&quot;</span>, *, retry : Bool = <span class="n">true</span>)</span>
     fail</a>, 
 
 
@@ -420,6 +420,16 @@ <h3>Instance methods inherited from class <code><a href="../Mosquito/Job.html">M
     run</a>, 
 
 
+    <a href="../Mosquito/Job.html#should_retry%3ABool-instance-method" class="tooltip">
+      <span>should_retry : Bool</span>
+    should_retry</a>, 
+
+
+    <a href="../Mosquito/Job.html#should_retry%3D%28should_retry%3ABool%29-instance-method" class="tooltip">
+      <span>should_retry=(should_retry : Bool)</span>
+    should_retry=</a>, 
+
+
     <a href="../Mosquito/Job.html#state%3AMosquito%3A%3AJob%3A%3AState-instance-method" class="tooltip">
       <span>state : Mosquito::Job::State</span>
     state</a>, 

diff --git a/Mosquito/ScheduledJob.html b/Mosquito/ScheduledJob.html
@@ -379,8 +379,8 @@ <h3>Instance methods inherited from class <code><a href="../Mosquito/Job.html">M
     executed?</a>, 
 
 
-    <a href="../Mosquito/Job.html#fail%28reason%3D%22%22%29-instance-method" class="tooltip">
-      <span>fail(reason = <span class="s">&quot;&quot;</span>)</span>
+    <a href="../Mosquito/Job.html#fail%28reason%3D%22%22%2C%2A%2Cretry%3ABool%3Dtrue%29-instance-method" class="tooltip">
+      <span>fail(reason = <span class="s">&quot;&quot;</span>, *, retry : Bool = <span class="n">true</span>)</span>
     fail</a>, 
 
 
@@ -434,6 +434,16 @@ <h3>Instance methods inherited from class <code><a href="../Mosquito/Job.html">M
     run</a>, 
 
 
+    <a href="../Mosquito/Job.html#should_retry%3ABool-instance-method" class="tooltip">
+      <span>should_retry : Bool</span>
+    should_retry</a>, 
+
+
+    <a href="../Mosquito/Job.html#should_retry%3D%28should_retry%3ABool%29-instance-method" class="tooltip">
+      <span>should_retry=(should_retry : Bool)</span>
+    should_retry=</a>, 
+
+
     <a href="../Mosquito/Job.html#state%3AMosquito%3A%3AJob%3A%3AState-instance-method" class="tooltip">
       <span>state : Mosquito::Job::State</span>
     state</a>, 

diff --git a/index.json b/index.json
diff --git a/search-index.js b/search-index.js