doc/SidekiqUniqueJobs/Lock/UntilAndWhileExecuting.html
<!DOCTYPE html><html> <head> <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title> Class: SidekiqUniqueJobs::Lock::UntilAndWhileExecutingUnexpected trailing spaces found. — Documentation by YARD 0.9.26Unexpected trailing spaces found. </title> <link rel="stylesheet" href="../../css/style.css" type="text/css" /> <link rel="stylesheet" href="../../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "SidekiqUniqueJobs::Lock::UntilAndWhileExecuting"; relpath = '../../';</script> <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu">Unexpected trailing spaces found. <a href="../../_index.html">Index (U)</a> » <span class='title'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span> » <span class='title'><span class='object_link'><a href="../Lock.html" title="SidekiqUniqueJobs::Lock (class)">Lock</a></span></span>Expected an indentation at 6 instead of at 5.
Unexpected trailing spaces found. » <span class="title">UntilAndWhileExecuting</span>Unexpected trailing spaces found. </div> <div id="search">Unexpected trailing spaces found. <a class="full_list_link" id="class_list_link" href="../../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a>Unexpected trailing spaces found. </div> <div class="clear"></div> </div> <div id="content"><h1>Class: SidekiqUniqueJobs::Lock::UntilAndWhileExecutingUnexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h1><div class="box_info">Unexpected trailing spaces found. <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="BaseLock.html" title="SidekiqUniqueJobs::Lock::BaseLock (class)">BaseLock</a></span></span>Unexpected trailing spaces found. <ul class="fullTree"> <li>Object</li>Unexpected trailing spaces found. <li class="next"><span class='object_link'><a href="BaseLock.html" title="SidekiqUniqueJobs::Lock::BaseLock (class)">BaseLock</a></span></li>Unexpected trailing spaces found. <li class="next">SidekiqUniqueJobs::Lock::UntilAndWhileExecuting</li>Unexpected trailing spaces found. </ul> <a href="#" class="inheritanceTree">show all</a>Unexpected trailing spaces found. </dd> </dl>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <dl> <dt>Defined in:</dt> <dd>lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb</dd> </dl>Unexpected trailing spaces found. </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Locks jobs while the job is executing in the server process</p> <ul><li>Locks on perform_in or perform_async (see <span class='object_link'><a href="UntilExecuting.html" title="SidekiqUniqueJobs::Lock::UntilExecuting (class)">UntilExecuting</a></span>)</li><li>Unlocks before yielding to the worker's perform method (see <span class='object_link'><a href="UntilExecuting.html" title="SidekiqUniqueJobs::Lock::UntilExecuting (class)">UntilExecuting</a></span>)</li><li>Locks before yielding to the worker's perform method (see <span class='object_link'><a href="WhileExecuting.html" title="SidekiqUniqueJobs::Lock::WhileExecuting (class)">WhileExecuting</a></span>)</li><li>Unlocks after yielding to the worker's perform method (see <span class='object_link'><a href="WhileExecuting.html" title="SidekiqUniqueJobs::Lock::WhileExecuting (class)">WhileExecuting</a></span>)</li></ul> <p>See <span class='object_link'><a href="#lock-instance_method" title="SidekiqUniqueJobs::Lock::UntilAndWhileExecuting#lock (method)">#lock</a></span> for more information about the client.See <span class='object_link'><a href="#execute-instance_method" title="SidekiqUniqueJobs::Lock::UntilAndWhileExecuting#execute (method)">#execute</a></span> for more information about the server</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Author:</p><ul class="author">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div class='inline'><p>Mikael Henriksson <a href="mailto:mikael@mhenrixon.com">mikael@mhenrixon.com</a></p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div> Unexpected trailing spaces found. <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary">Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#execute-instance_method" title="#execute (instance method)">#<strong>execute</strong> { ... } ⇒ Object </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Executes in the Sidekiq server process.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#lock-instance_method" title="#lock (instance method)">#<strong>lock</strong>(origin: :client) { ... } ⇒ String<sup>?</sup> </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Locks a sidekiq job.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. </ul>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2>Unexpected trailing spaces found. <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BaseLock.html#initialize-instance_method" title="SidekiqUniqueJobs::Lock::BaseLock#initialize (method)">SidekiqUniqueJobs::Lock::BaseLock</a></span></p>Unexpected trailing spaces found. </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> Unexpected trailing spaces found. <div class="method_details first"> <h3 class="signature first" id="execute-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>execute</strong> { ... } ⇒ <tt>Object</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Executes in the Sidekiq server process</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Yields:</p><ul class="yield">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'></span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div class='inline'><p>to the worker class perform method</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 4041424344454647484950515253</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb', line 40</span> <span class='kw'>def</span> <span class='id identifier rubyid_execute'>execute</span> <span class='kw'>if</span> <span class='id identifier rubyid_locksmith'>locksmith</span><span class='period'>.</span><span class='id identifier rubyid_unlock'>unlock</span> <span class='comment'># ensure_relocked do</span> <span class='id identifier rubyid_runtime_lock'>runtime_lock</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span> <span class='lbrace'>{</span> <span class='kw'>return</span> <span class='kw'>yield</span> <span class='rbrace'>}</span> <span class='comment'># end</span> <span class='kw'>else</span> <span class='id identifier rubyid_reflect'>reflect</span><span class='lparen'>(</span><span class='symbol'>:unlock_failed</span><span class='comma'>,</span> <span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='kw'>end</span><span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='comment'># rubocop:disable Lint/RescueException</span> <span class='id identifier rubyid_reflect'>reflect</span><span class='lparen'>(</span><span class='symbol'>:execution_failed</span><span class='comma'>,</span> <span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_locksmith'>locksmith</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span><span class='lparen'>(</span><span class='label'>wait:</span> <span class='int'>2</span><span class='rparen'>)</span> <span class='id identifier rubyid_raise'>raise</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="lock-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>lock</strong>(origin: :client) { ... } ⇒ <tt>String</tt><sup>?</sup> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion">Unexpected trailing spaces found. <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>Will call a conflict strategy if lock can't be achieved.</p></div> </div> <p>Locks a sidekiq job</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Yields:</p><ul class="yield">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'></span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div class='inline'><p>to the caller when given a block</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul><p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the locked jid when properly locked, else nil.</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 252627282930313233343536</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb', line 25</span> <span class='kw'>def</span> <span class='id identifier rubyid_lock'>lock</span><span class='lparen'>(</span><span class='label'>origin:</span> <span class='symbol'>:client</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='id identifier rubyid_locksmith'>locksmith</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span><span class='rparen'>)</span> <span class='id identifier rubyid_reflect'>reflect</span><span class='lparen'>(</span><span class='symbol'>:lock_failed</span><span class='comma'>,</span> <span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_call_strategy'>call_strategy</span><span class='lparen'>(</span><span class='label'>origin:</span> <span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='kw'>end</span> <span class='kw'>yield</span> <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span> <span class='id identifier rubyid_token'>token</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. </div> </div> <div id="footer"> Generated on Mon Sep 27 15:29:10 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.2).</div> </div> </body>Expected a newline at the end of the file.</html>