doc/SidekiqUniqueJobs/OnConflict.html
<!DOCTYPE html><html> <head> <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title> Module: SidekiqUniqueJobs::OnConflictUnexpected 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::OnConflict"; 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 (O)</a> » <span class='title'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span>Expected an indentation at 6 instead of at 5.
Unexpected trailing spaces found. » <span class="title">OnConflict</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>Module: SidekiqUniqueJobs::OnConflictUnexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h1><div class="box_info">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/on_conflict.rb<span class="defines">,<br /> lib/sidekiq_unique_jobs/on_conflict/log.rb,<br /> lib/sidekiq_unique_jobs/on_conflict/raise.rb,<br /> lib/sidekiq_unique_jobs/on_conflict/reject.rb,<br /> lib/sidekiq_unique_jobs/on_conflict/replace.rb,<br /> lib/sidekiq_unique_jobs/on_conflict/strategy.rb,<br /> lib/sidekiq_unique_jobs/on_conflict/reschedule.rb,<br /> lib/sidekiq_unique_jobs/on_conflict/null_strategy.rb</span></dd> </dl>Unexpected trailing spaces found. </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Provides lock conflict resolutions</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><h2>Defined Under Namespace</h2><p class="children">Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <strong class="classes">Classes:</strong> <span class='object_link'><a href="OnConflict/Log.html" title="SidekiqUniqueJobs::OnConflict::Log (class)">Log</a></span>, <span class='object_link'><a href="OnConflict/NullStrategy.html" title="SidekiqUniqueJobs::OnConflict::NullStrategy (class)">NullStrategy</a></span>, <span class='object_link'><a href="OnConflict/Raise.html" title="SidekiqUniqueJobs::OnConflict::Raise (class)">Raise</a></span>, <span class='object_link'><a href="OnConflict/Reject.html" title="SidekiqUniqueJobs::OnConflict::Reject (class)">Reject</a></span>, <span class='object_link'><a href="OnConflict/Replace.html" title="SidekiqUniqueJobs::OnConflict::Replace (class)">Replace</a></span>, <span class='object_link'><a href="OnConflict/Reschedule.html" title="SidekiqUniqueJobs::OnConflict::Reschedule (class)">Reschedule</a></span>, <span class='object_link'><a href="OnConflict/Strategy.html" title="SidekiqUniqueJobs::OnConflict::Strategy (class)">Strategy</a></span>Unexpected trailing spaces found. Unexpected trailing spaces found. </p> Unexpected trailing spaces found. <h2> Class 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="#find_strategy-class_method" title="find_strategy (class method)">.<strong>find_strategy</strong>(strategy) ⇒ OnConflict::Strategy, OnConflict::NullStrategy </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>Find a strategy to use for conflicting locks.</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="#strategies-class_method" title="strategies (class method)">.<strong>strategies</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>A convenience method for using the configured strategies.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. </ul>Unexpected trailing spaces found. <div id="class_method_details" class="method_details_list"> <h2>Class Method Details</h2> Unexpected trailing spaces found. <div class="method_details first"> <h3 class="signature first" id="find_strategy-class_method">Unexpected trailing spaces found. Unexpected trailing spaces found. .<strong>find_strategy</strong>(strategy) ⇒ <tt><span class='object_link'><a href="OnConflict/Strategy.html" title="SidekiqUniqueJobs::OnConflict::Strategy (class)">OnConflict::Strategy</a></span></tt>, <tt><span class='object_link'><a href="OnConflict/NullStrategy.html" title="SidekiqUniqueJobs::OnConflict::NullStrategy (class)">OnConflict::NullStrategy</a></span></tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Find a strategy to use for conflicting locks</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>strategy</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>Symbol</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the key for the strategy</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><span class='object_link'><a href="OnConflict/Strategy.html" title="SidekiqUniqueJobs::OnConflict::Strategy (class)">OnConflict::Strategy</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>when found</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="OnConflict/NullStrategy.html" title="SidekiqUniqueJobs::OnConflict::NullStrategy (class)">OnConflict::NullStrategy</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>when no other could be found</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 313233343536373839404142</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict.rb', line 31</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find_strategy'>find_strategy</span><span class='lparen'>(</span><span class='id identifier rubyid_strategy'>strategy</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='const'><span class='object_link'><a href="" title="SidekiqUniqueJobs::OnConflict (module)">OnConflict</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="OnConflict/NullStrategy.html" title="SidekiqUniqueJobs::OnConflict::NullStrategy (class)">NullStrategy</a></span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_strategy'>strategy</span> <span class='id identifier rubyid_strategies'>strategies</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_strategy'>strategy</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='period'>.</span><span class='id identifier rubyid_logger'><span class='object_link'><a href="../SidekiqUniqueJobs.html#logger-class_method" title="SidekiqUniqueJobs.logger (method)">logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No matching implementation for strategy: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_strategy'>strategy</span><span class='embexpr_end'>}</span><span class='tstring_content'>, returning OnConflict::NullStrategy.</span><span class='tstring_end'>"</span></span> \ <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> Available strategies are (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_strategies'>strategies</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='rparen'>)</span> <span class='const'><span class='object_link'><a href="" title="SidekiqUniqueJobs::OnConflict (module)">OnConflict</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="OnConflict/NullStrategy.html" title="SidekiqUniqueJobs::OnConflict::NullStrategy (class)">NullStrategy</a></span></span> <span class='kw'>end</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="strategies-class_method">Unexpected trailing spaces found. Unexpected trailing spaces found. .<strong>strategies</strong> ⇒ <tt>Object</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>A convenience method for using the configured strategies</p> </div></div><div class="tags">Unexpected trailing spaces found. </div><table class="source_code"> <tr> <td> <pre class="lines"> 192021</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict.rb', line 19</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_strategies'>strategies</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='period'>.</span><span class='id identifier rubyid_strategies'><span class='object_link'><a href="../SidekiqUniqueJobs.html#strategies-class_method" title="SidekiqUniqueJobs.strategies (method)">strategies</a></span></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:05 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>