doc/SidekiqUniqueJobs/RedisScript.html
<!DOCTYPE html><html> <head> <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title> Module: SidekiqUniqueJobs::RedisScriptUnexpected trailing spaces found. — Documentation by YARD 0.9.34Unexpected 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::RedisScript"; 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 (R)</a> » <span class='title'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span>Unexpected trailing spaces found.
Expected an indentation at 6 instead of at 5. » <span class="title">RedisScript</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::RedisScriptUnexpected 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/redis_script.rb<span class="defines">,<br /> lib/sidekiq_unique_jobs/redis_script/dsl.rb,<br /> lib/sidekiq_unique_jobs/redis_script/client.rb,<br /> lib/sidekiq_unique_jobs/redis_script/config.rb,<br /> lib/sidekiq_unique_jobs/redis_script/script.rb,<br /> lib/sidekiq_unique_jobs/redis_script/timing.rb,<br /> lib/sidekiq_unique_jobs/redis_script/logging.rb,<br /> lib/sidekiq_unique_jobs/redis_script/scripts.rb,<br /> lib/sidekiq_unique_jobs/redis_script/template.rb,<br /> lib/sidekiq_unique_jobs/redis_script/lua_error.rb</span></dd> </dl>Unexpected trailing spaces found. </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Interface to dealing with .lua files</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. <strong class="modules">Modules:</strong> <span class='object_link'><a href="RedisScript/DSL.html" title="SidekiqUniqueJobs::RedisScript::DSL (module)">DSL</a></span>, <span class='object_link'><a href="RedisScript/Logging.html" title="SidekiqUniqueJobs::RedisScript::Logging (module)">Logging</a></span>, <span class='object_link'><a href="RedisScript/Timing.html" title="SidekiqUniqueJobs::RedisScript::Timing (module)">Timing</a></span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <strong class="classes">Classes:</strong> <span class='object_link'><a href="RedisScript/Client.html" title="SidekiqUniqueJobs::RedisScript::Client (class)">Client</a></span>, <span class='object_link'><a href="RedisScript/Config.html" title="SidekiqUniqueJobs::RedisScript::Config (class)">Config</a></span>, <span class='object_link'><a href="RedisScript/LuaError.html" title="SidekiqUniqueJobs::RedisScript::LuaError (class)">LuaError</a></span>, <span class='object_link'><a href="RedisScript/Misconfiguration.html" title="SidekiqUniqueJobs::RedisScript::Misconfiguration (class)">Misconfiguration</a></span>, <span class='object_link'><a href="RedisScript/Script.html" title="SidekiqUniqueJobs::RedisScript::Script (class)">Script</a></span>, <span class='object_link'><a href="RedisScript/Scripts.html" title="SidekiqUniqueJobs::RedisScript::Scripts (class)">Scripts</a></span>, <span class='object_link'><a href="RedisScript/Template.html" title="SidekiqUniqueJobs::RedisScript::Template (class)">Template</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="#execute-class_method" title="execute (class method)">.<strong>execute</strong>(script_name, conn, keys: [], argv: []) ⇒ 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>Execute the given script_name.</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-class_method" title="logger (class method)">.<strong>logger</strong> ⇒ Logger </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>The current 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="#logger=-class_method" title="logger= (class method)">.<strong>logger=</strong>(other) ⇒ Logger </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>Set a new logger.</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="execute-class_method">Unexpected trailing spaces found. Unexpected trailing spaces found. .<strong>execute</strong>(script_name, conn, keys: [], argv: []) ⇒ <tt>Object</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Execute the given script_name</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'>script_name</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 name of the lua script</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>keys</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><String></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>[]</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>script keys</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>argv</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><Object></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>[]</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>script arguments</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>conn</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="Redis.html" title="SidekiqUniqueJobs::Redis (module)">Redis</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the redis connection to use</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'></span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div class='inline'><p>value from script</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 545556</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/redis_script.rb', line 54</span> <span class='kw'>def</span> <span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='id identifier rubyid_script_name'>script_name</span><span class='comma'>,</span> <span class='id identifier rubyid_conn'>conn</span><span class='comma'>,</span> <span class='label'>keys:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>argv:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='const'><span class='object_link'><a href="RedisScript/Client.html" title="SidekiqUniqueJobs::RedisScript::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_execute'><span class='object_link'><a href="RedisScript/Client.html#execute-instance_method" title="SidekiqUniqueJobs::RedisScript::Client#execute (method)">execute</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_script_name'>script_name</span><span class='comma'>,</span> <span class='id identifier rubyid_conn'>conn</span><span class='comma'>,</span> <span class='label'>keys:</span> <span class='id identifier rubyid_keys'>keys</span><span class='comma'>,</span> <span class='label'>argv:</span> <span class='id identifier rubyid_argv'>argv</span><span class='rparen'>)</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="logger-class_method">Unexpected trailing spaces found. Unexpected trailing spaces found. .<strong>logger</strong> ⇒ <tt>Logger</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>The current 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. — <div class='inline'><p>the configured logger</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 282930</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/redis_script.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="logger=-class_method">Unexpected trailing spaces found. Unexpected trailing spaces found. .<strong>logger=</strong>(other) ⇒ <tt>Logger</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Set a new logger</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'>other</span>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. — <div class='inline'><p>another logger</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>Logger</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the new logger</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 394041</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/redis_script.rb', line 39</span> <span class='kw'>def</span> <span class='id identifier rubyid_logger='>logger=</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='id identifier rubyid_other'>other</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. </div> </div> <div id="footer"> Generated on Wed Jan 24 10:57:23 2024 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.34 (ruby-3.3.0).</div> </div> </body>Expected a newline at the end of the file.</html>