doc/SidekiqUniqueJobs/Lock/WhileExecuting.html from mhenrixon/sidekiq-unique-jobs

doc/SidekiqUniqueJobs/Lock/WhileExecuting.html
Summary

Maintainability

Test Coverage

Issues
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Class: SidekiqUniqueJobs::Lock::WhileExecuting
Unexpected trailing spaces found.
  
    &mdash; Documentation by YARD 0.9.26
Unexpected 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::WhileExecuting";
  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 (W)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span> &raquo; <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.
     &raquo; 
    <span class="title">WhileExecuting</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::WhileExecuting
Unexpected 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::WhileExecuting</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.
  
  <dl>
      <dt>Includes:</dt>
      <dd><span class='object_link'><a href="../Logging/Middleware.html" title="SidekiqUniqueJobs::Logging::Middleware (module)">SidekiqUniqueJobs::Logging::Middleware</a></span>, <span class='object_link'><a href="../OptionsWithFallback.html" title="SidekiqUniqueJobs::OptionsWithFallback (module)">OptionsWithFallback</a></span></dd>
  </dl>
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/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 before yielding to the worker&#39;s perform method</li>
<li>Unlocks after yielding to the worker&#39;s perform method</li>
</ul>
 
<p>See <span class='object_link'><a href="#lock-instance_method" title="SidekiqUniqueJobs::Lock::WhileExecuting#lock (method)">#lock</a></span> for more information about the client.
See <span class='object_link'><a href="#execute-instance_method" title="SidekiqUniqueJobs::Lock::WhileExecuting#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><div id="subclasses">
  <h2>Direct Known Subclasses</h2>
  <p class="children"><span class='object_link'><a href="WhileExecutingReject.html" title="SidekiqUniqueJobs::Lock::WhileExecutingReject (class)">WhileExecutingReject</a></span></p>
</div>
 
Unexpected trailing spaces found.
  
    <h2>
      Constant Summary
      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
    </h2>
 
    <dl class="constants">
Unexpected trailing spaces found.
      
        <dt id="RUN_SUFFIX-constant" class="">RUN_SUFFIX =
Unexpected trailing spaces found.
          
        </dt>
        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>:RUN</span><span class='tstring_end'>&quot;</span></span></pre></dd>
Unexpected trailing spaces found.
      
    </dl>
Unexpected trailing spaces found.
  
 
 
 
 
 
 
 
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="#build_message-instance_method" title="#build_message (instance method)">#<strong>build_message</strong>(message_or_exception, item = nil)  &#x21d2; String </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#build_message-instance_method" title="SidekiqUniqueJobs::Logging#build_message (method)">SidekiqUniqueJobs::Logging</a></span>
    </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>Build a log message.</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="#execute-instance_method" title="#execute (instance method)">#<strong>execute</strong> { ... } &#x21d2; 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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(item, callback, redis_pool = nil)  &#x21d2; WhileExecuting </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
  
    <span class="note title constructor">constructor</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.
  
    <span class="summary_desc"><div class='inline'><p>A new instance of WhileExecuting.</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>  &#x21d2; true </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>Simulate that a client lock was achieved.</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_class-instance_method" title="#lock_class (instance method)">#<strong>lock_class</strong>  &#x21d2; Class </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../OptionsWithFallback.html#lock_class-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#lock_class (method)">OptionsWithFallback</a></span>
    </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>Returns the corresponding class for the lock_type.</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-instance_method" title="#lock_instance (instance method)">#<strong>lock_instance</strong>  &#x21d2; Lock::BaseLock </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../OptionsWithFallback.html#lock_instance-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#lock_instance (method)">OptionsWithFallback</a></span>
    </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 new lock for this Sidekiq Job.</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_type-instance_method" title="#lock_type (instance method)">#<strong>lock_type</strong>  &#x21d2; Symbol </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../OptionsWithFallback.html#lock_type-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#lock_type (method)">OptionsWithFallback</a></span>
    </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>The type of lock for this worker.</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="#locks-instance_method" title="#locks (instance method)">#<strong>locks</strong>  &#x21d2; Object </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../OptionsWithFallback.html#locks-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#locks (method)">OptionsWithFallback</a></span>
    </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 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="#log_debug-instance_method" title="#log_debug (instance method)">#<strong>log_debug</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#log_debug-instance_method" title="SidekiqUniqueJobs::Logging#log_debug (method)">SidekiqUniqueJobs::Logging</a></span>
    </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>Logs a message at debug level.</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="#log_error-instance_method" title="#log_error (instance method)">#<strong>log_error</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#log_error-instance_method" title="SidekiqUniqueJobs::Logging#log_error (method)">SidekiqUniqueJobs::Logging</a></span>
    </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>Logs a message at error level.</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="#log_fatal-instance_method" title="#log_fatal (instance method)">#<strong>log_fatal</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#log_fatal-instance_method" title="SidekiqUniqueJobs::Logging#log_fatal (method)">SidekiqUniqueJobs::Logging</a></span>
    </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>Logs a message at fatal level.</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="#log_info-instance_method" title="#log_info (instance method)">#<strong>log_info</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#log_info-instance_method" title="SidekiqUniqueJobs::Logging#log_info (method)">SidekiqUniqueJobs::Logging</a></span>
    </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>Logs a message at info level.</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="#log_warn-instance_method" title="#log_warn (instance method)">#<strong>log_warn</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#log_warn-instance_method" title="SidekiqUniqueJobs::Logging#log_warn (method)">SidekiqUniqueJobs::Logging</a></span>
    </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>Logs a message at warn level.</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="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong>  &#x21d2; Logger </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#logger-instance_method" title="SidekiqUniqueJobs::Logging#logger (method)">SidekiqUniqueJobs::Logging</a></span>
    </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 gem logger.</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="#logging_context-instance_method" title="#logging_context (instance method)">#<strong>logging_context</strong>  &#x21d2; Hash, String </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging/Middleware.html#logging_context-instance_method" title="SidekiqUniqueJobs::Logging::Middleware#logging_context (method)">SidekiqUniqueJobs::Logging::Middleware</a></span>
    </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>Provides a logging context for Sidekiq Middlewares.</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="#options-instance_method" title="#options (instance method)">#<strong>options</strong>  &#x21d2; Hash&lt;String, Object&gt; </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../OptionsWithFallback.html#options-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#options (method)">OptionsWithFallback</a></span>
    </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>The default options with any matching keys overridden from worker options.</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="#unique_disabled%3F-instance_method" title="#unique_disabled? (instance method)">#<strong>unique_disabled?</strong>  &#x21d2; Boolean </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../OptionsWithFallback.html#unique_disabled%3F-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#unique_disabled? (method)">OptionsWithFallback</a></span>
    </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>Check if unique has been disabled.</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="#unique_enabled%3F-instance_method" title="#unique_enabled? (instance method)">#<strong>unique_enabled?</strong>  &#x21d2; true, false </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../OptionsWithFallback.html#unique_enabled%3F-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#unique_enabled? (method)">OptionsWithFallback</a></span>
    </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>Check if unique has been enabled.</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="#with_configured_loggers_context-instance_method" title="#with_configured_loggers_context (instance method)">#<strong>with_configured_loggers_context</strong> { ... } &#x21d2; void </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#with_configured_loggers_context-instance_method" title="SidekiqUniqueJobs::Logging#with_configured_loggers_context (method)">SidekiqUniqueJobs::Logging</a></span>
    </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>Attempt to setup context aware logging for the given logger.</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="#with_logging_context-instance_method" title="#with_logging_context (instance method)">#<strong>with_logging_context</strong>  &#x21d2; void </a>
Unexpected trailing spaces found.
    
 
Unexpected trailing spaces found.
    
  </span>
Unexpected trailing spaces found.
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="../Logging.html#with_logging_context-instance_method" title="SidekiqUniqueJobs::Logging#with_logging_context (method)">SidekiqUniqueJobs::Logging</a></span>
    </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>Wraps the middleware logic with context aware logging.</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.
  
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.
  
    <div class="method_details first">
  <h3 class="signature first" id="initialize-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>initialize</strong>(item, callback, redis_pool = nil)  &#x21d2; <tt><span class='object_link'><a href="" title="SidekiqUniqueJobs::Lock::WhileExecuting (class)">WhileExecuting</a></span></tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>Returns a new instance of WhileExecuting.</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'>item</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the Sidekiq job hash</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
    <li>
Unexpected trailing spaces found.
      
        <span class='name'>callback</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>Proc</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>callback to call after unlock</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
    <li>
Unexpected trailing spaces found.
      
        <span class='name'>redis_pool</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>Sidekiq::RedisConnection</tt>, <tt>ConnectionPool</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the redis connection</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
 
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
 
 
23
24
25
26</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/while_executing.rb', line 23</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_append_unique_key_suffix'>append_unique_key_suffix</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
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="build_message-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>build_message</strong>(message_or_exception, item = nil)  &#x21d2; <tt>String</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#build_message-instance_method" title="SidekiqUniqueJobs::Logging#build_message (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>Build a log message</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'>message_or_exception</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>an entry to log</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
    <li>
Unexpected trailing spaces found.
      
        <span class='name'>item</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the sidekiq job hash</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>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>a complete log entry</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="execute-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>execute</strong> { ... } &#x21d2; <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.
  These jobs are locked in the server process not from the client</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">
 
 
41
42
43
44
45
46
47
48
49
50
51
52</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/while_executing.rb', line 41</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_with_logging_context'>with_logging_context</span> <span class='kw'>do</span>
    <span class='id identifier rubyid_executed'>executed</span> <span class='op'>=</span> <span class='id identifier rubyid_locksmith'>locksmith</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span> <span class='kw'>do</span>
      <span class='kw'>yield</span>
      <span class='id identifier rubyid_callback_safely'>callback_safely</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='kw'>ensure</span>
      <span class='id identifier rubyid_locksmith'>locksmith</span><span class='period'>.</span><span class='id identifier rubyid_unlock'>unlock</span>
    <span class='kw'>end</span>
 
    <span class='id identifier rubyid_call_strategy'>call_strategy</span><span class='lparen'>(</span><span class='label'>origin:</span> <span class='symbol'>:server</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_executed'>executed</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="lock-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>lock</strong>  &#x21d2; <tt>true</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>Simulate that a client lock was achieved.
  These locks should only ever be created in the server process.</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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>true</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>always returns true</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
 
 
31
32
33
34
35
36</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/while_executing.rb', line 31</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_lock'>lock</span>
  <span class='id identifier rubyid_job_id'>job_id</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html#JID-constant" title="SidekiqUniqueJobs::JID (constant)">JID</a></span></span><span class='rbracket'>]</span>
  <span class='kw'>yield</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
 
  <span class='id identifier rubyid_job_id'>job_id</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="lock_class-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>lock_class</strong>  &#x21d2; <tt>Class</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../OptionsWithFallback.html#lock_class-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#lock_class (method)">OptionsWithFallback</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>Returns the corresponding class for the lock_type</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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>Class</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="lock_instance-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>lock_instance</strong>  &#x21d2; <tt><span class='object_link'><a href="BaseLock.html" title="SidekiqUniqueJobs::Lock::BaseLock (class)">Lock::BaseLock</a></span></tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../OptionsWithFallback.html#lock_instance-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#lock_instance (method)">OptionsWithFallback</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>A new lock for this Sidekiq Job</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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="BaseLock.html" title="SidekiqUniqueJobs::Lock::BaseLock (class)">Lock::BaseLock</a></span></tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>an instance of a lock implementation</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="lock_type-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>lock_type</strong>  &#x21d2; <tt>Symbol</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../OptionsWithFallback.html#lock_type-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#lock_type (method)">OptionsWithFallback</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>The type of lock for this worker</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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>Symbol</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="locks-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>locks</strong>  &#x21d2; <tt>Object</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../OptionsWithFallback.html#locks-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#locks (method)">OptionsWithFallback</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>A convenience method for using the configured locks</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="log_debug-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>log_debug</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#log_debug-instance_method" title="SidekiqUniqueJobs::Logging#log_debug (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at debug level</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'>message_or_exception</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
<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'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="log_error-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>log_error</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#log_error-instance_method" title="SidekiqUniqueJobs::Logging#log_error (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at error level</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'>message_or_exception</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
<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'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="log_fatal-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>log_fatal</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#log_fatal-instance_method" title="SidekiqUniqueJobs::Logging#log_fatal (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at fatal level</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'>message_or_exception</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
<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'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="log_info-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>log_info</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#log_info-instance_method" title="SidekiqUniqueJobs::Logging#log_info (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at info level</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'>message_or_exception</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
<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'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="log_warn-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>log_warn</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#log_warn-instance_method" title="SidekiqUniqueJobs::Logging#log_warn (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at warn level</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'>message_or_exception</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
<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'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="logger-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>logger</strong>  &#x21d2; <tt>Logger</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#logger-instance_method" title="SidekiqUniqueJobs::Logging#logger (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>A convenience method for using the configured gem logger</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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>Logger</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
  <p class="tag_title">See Also:</p>
  <ul class="see">
Unexpected trailing spaces found.
    
      <li>SidekiqUniqueJobs#.logger</li>
Unexpected trailing spaces found.
    
  </ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="logging_context-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>logging_context</strong>  &#x21d2; <tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>, <tt>String</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging/Middleware.html#logging_context-instance_method" title="SidekiqUniqueJobs::Logging::Middleware#logging_context (method)">SidekiqUniqueJobs::Logging::Middleware</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>Provides a logging context for Sidekiq Middlewares</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>when logger responds to <code>:with_context</code></p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
    <li>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>String</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>when logger does not responds to <code>:with_context</code></p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="options-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>options</strong>  &#x21d2; <tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span>&lt;String, Object&gt;</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../OptionsWithFallback.html#options-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#options (method)">OptionsWithFallback</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>The default options with any matching keys overridden from worker options</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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="../../Hash.html" title="Hash (class)">Hash</a></span>&lt;String, Object&gt;</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="unique_disabled?-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>unique_disabled?</strong>  &#x21d2; <tt>Boolean</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../OptionsWithFallback.html#unique_disabled%3F-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#unique_disabled? (method)">OptionsWithFallback</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>Check if unique has been disabled</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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>Boolean</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="unique_enabled?-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>unique_enabled?</strong>  &#x21d2; <tt>true</tt>, <tt>false</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../OptionsWithFallback.html#unique_enabled%3F-instance_method" title="SidekiqUniqueJobs::OptionsWithFallback#unique_enabled? (method)">OptionsWithFallback</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p>Check if unique has been enabled</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<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>true</tt>, <tt>false</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>indicate if the gem has been enabled</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="with_configured_loggers_context-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>with_configured_loggers_context</strong> { ... } &#x21d2; <tt>void</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#with_configured_loggers_context-instance_method" title="SidekiqUniqueJobs::Logging#with_configured_loggers_context (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p class="note returns_void">This method returns an undefined value.</p><p>Attempt to setup context aware logging for the given logger</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.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
      <div class="method_details ">
  <h3 class="signature " id="with_logging_context-instance_method">
Unexpected trailing spaces found.
  
Unexpected trailing spaces found.
    #<strong>with_logging_context</strong>  &#x21d2; <tt>void</tt> 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
 
Unexpected trailing spaces found.
  
    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="../Logging.html#with_logging_context-instance_method" title="SidekiqUniqueJobs::Logging#with_logging_context (method)">SidekiqUniqueJobs::Logging</a></span>
    </span>
Unexpected trailing spaces found.
  
</h3><div class="docstring">
  <div class="discussion">
    <p class="note returns_void">This method returns an undefined value.</p><p>Wraps the middleware logic with context aware logging</p>
 
 
  </div>
</div>
<div class="tags">
Unexpected trailing spaces found.
  
<p class="tag_title">Yield Returns:</p>
<ul class="yieldreturn">
Unexpected trailing spaces found.
  
    <li>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        <span class='type'>(<tt>void</tt>)</span>
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
Unexpected trailing spaces found.
      
        &mdash;
        <div class='inline'><p>yield to the middleware instance</p>
</div>
Unexpected trailing spaces found.
      
    </li>
Unexpected trailing spaces found.
  
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
    
  </div>
 
</div>
 
      <div id="footer">
  Generated on Mon Sep 27 15:29:09 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>