Files
metasploit-gs/api/Msf/Exploit/Retry.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

274 lines
9.2 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Msf::Exploit::Retry
&mdash; Documentation by YARD 0.9.37
</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 = "Msf::Exploit::Retry";
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">
<a href="../../_index.html">Index (R)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Msf.html" title="Msf (module)">Msf</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Exploit.html" title="Msf::Exploit (class)">Exploit</a></span></span>
&raquo;
<span class="title">Retry</span>
</div>
<div id="search">
<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>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Msf::Exploit::Retry
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Remote/HTTP/Atlassian/Confluence/PayloadPlugin.html" title="Msf::Exploit::Remote::HTTP::Atlassian::Confluence::PayloadPlugin (module)">Msf::Exploit::Remote::HTTP::Atlassian::Confluence::PayloadPlugin</a></span>, <span class='object_link'><a href="Remote/HTTP/SCCM.html" title="Msf::Exploit::Remote::HTTP::SCCM (module)">Msf::Exploit::Remote::HTTP::SCCM</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/exploit/retry.rb</dd>
</dl>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#retry_until_truthy-instance_method" title="#retry_until_truthy (instance method)">#<strong>retry_until_truthy</strong>(timeout:) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Retry the block until it returns a truthy value.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="retry_until_truthy-instance_method">
#<strong>retry_until_truthy</strong>(timeout:) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Retry the block until it returns a truthy value. Each iteration attempt will be performed with an exponential backoff. If the timeout period surpasses, nil is returned.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>Integer</span>
<span class='type'></span>
&mdash;
<div class='inline'>
<p>timeout the number of seconds to wait before the operation times out</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the truthy value of the block is returned or nil if it timed out</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/retry.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_retry_until_truthy'>retry_until_truthy</span><span class='lparen'>(</span><span class='label'>timeout:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_start_time'>start_time</span> <span class='op'>=</span> <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_clock_gettime'>clock_gettime</span><span class='lparen'>(</span><span class='const'>Process</span><span class='op'>::</span><span class='const'>CLOCK_MONOTONIC</span><span class='comma'>,</span> <span class='symbol'>:second</span><span class='rparen'>)</span>
<span class='id identifier rubyid_ending_time'>ending_time</span> <span class='op'>=</span> <span class='id identifier rubyid_start_time'>start_time</span> <span class='op'>+</span> <span class='id identifier rubyid_timeout'>timeout</span>
<span class='id identifier rubyid_retry_count'>retry_count</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='kw'>while</span> <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_clock_gettime'>clock_gettime</span><span class='lparen'>(</span><span class='const'>Process</span><span class='op'>::</span><span class='const'>CLOCK_MONOTONIC</span><span class='comma'>,</span> <span class='symbol'>:second</span><span class='rparen'>)</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_ending_time'>ending_time</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='kw'>yield</span>
<span class='kw'>return</span> <span class='id identifier rubyid_result'>result</span> <span class='kw'>if</span> <span class='id identifier rubyid_result'>result</span>
<span class='id identifier rubyid_retry_count'>retry_count</span> <span class='op'>+=</span> <span class='int'>1</span>
<span class='id identifier rubyid_remaining_time_budget'>remaining_time_budget</span> <span class='op'>=</span> <span class='id identifier rubyid_ending_time'>ending_time</span> <span class='op'>-</span> <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_clock_gettime'>clock_gettime</span><span class='lparen'>(</span><span class='const'>Process</span><span class='op'>::</span><span class='const'>CLOCK_MONOTONIC</span><span class='comma'>,</span> <span class='symbol'>:second</span><span class='rparen'>)</span>
<span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_remaining_time_budget'>remaining_time_budget</span> <span class='op'>&lt;=</span> <span class='int'>0</span>
<span class='id identifier rubyid_delay'>delay</span> <span class='op'>=</span> <span class='int'>2</span><span class='op'>**</span><span class='id identifier rubyid_retry_count'>retry_count</span>
<span class='kw'>if</span> <span class='id identifier rubyid_delay'>delay</span> <span class='op'>&gt;=</span> <span class='id identifier rubyid_remaining_time_budget'>remaining_time_budget</span>
<span class='id identifier rubyid_delay'>delay</span> <span class='op'>=</span> <span class='id identifier rubyid_remaining_time_budget'>remaining_time_budget</span>
<span class='id identifier rubyid_vprint_status'>vprint_status</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Final attempt. Sleeping for the remaining </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_delay'>delay</span><span class='embexpr_end'>}</span><span class='tstring_content'> seconds out of total timeout </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_timeout'>timeout</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_vprint_status'>vprint_status</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Sleeping for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_delay'>delay</span><span class='embexpr_end'>}</span><span class='tstring_content'> seconds before attempting again</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_sleep'>sleep</span> <span class='id identifier rubyid_delay'>delay</span>
<span class='kw'>end</span>
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:01:06 2026 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.1.5).
</div>
</div>
</body>
</html>