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

314 lines
10 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Msf::OptPort
&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::OptPort";
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 (O)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span>
&raquo;
<span class="title">OptPort</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>Class: Msf::OptPort
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="OptInt.html" title="Msf::OptInt (class)">OptInt</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="OptBase.html" title="Msf::OptBase (class)">OptBase</a></span></li>
<li class="next"><span class='object_link'><a href="OptInt.html" title="Msf::OptInt (class)">OptInt</a></span></li>
<li class="next">Msf::OptPort</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/opt_port.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Network port option.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="OptBase.html" title="Msf::OptBase (class)">OptBase</a></span></h3>
<p class="inherited"><span class='object_link'><a href="OptBase.html#advanced-instance_method" title="Msf::OptBase#advanced (method)">#advanced</a></span>, <span class='object_link'><a href="OptBase.html#aliases-instance_method" title="Msf::OptBase#aliases (method)">#aliases</a></span>, <span class='object_link'><a href="OptBase.html#conditions-instance_method" title="Msf::OptBase#conditions (method)">#conditions</a></span>, <span class='object_link'><a href="OptBase.html#default-instance_method" title="Msf::OptBase#default (method)">#default</a></span>, <span class='object_link'><a href="OptBase.html#desc-instance_method" title="Msf::OptBase#desc (method)">#desc</a></span>, <span class='object_link'><a href="OptBase.html#enums-instance_method" title="Msf::OptBase#enums (method)">#enums</a></span>, <span class='object_link'><a href="OptBase.html#evasion-instance_method" title="Msf::OptBase#evasion (method)">#evasion</a></span>, <span class='object_link'><a href="OptBase.html#fallbacks-instance_method" title="Msf::OptBase#fallbacks (method)">#fallbacks</a></span>, <span class='object_link'><a href="OptBase.html#max_length-instance_method" title="Msf::OptBase#max_length (method)">#max_length</a></span>, <span class='object_link'><a href="OptBase.html#name-instance_method" title="Msf::OptBase#name (method)">#name</a></span>, <span class='object_link'><a href="OptBase.html#owner-instance_method" title="Msf::OptBase#owner (method)">#owner</a></span>, <span class='object_link'><a href="OptBase.html#regex-instance_method" title="Msf::OptBase#regex (method)">#regex</a></span>, <span class='object_link'><a href="OptBase.html#required-instance_method" title="Msf::OptBase#required (method)">#required</a></span></p>
<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="#type-instance_method" title="#type (instance method)">#<strong>type</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#valid%3F-instance_method" title="#valid? (instance method)">#<strong>valid?</strong>(value, check_empty: true, datastore: nil) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="OptInt.html" title="Msf::OptInt (class)">OptInt</a></span></h3>
<p class="inherited"><span class='object_link'><a href="OptInt.html#normalize-instance_method" title="Msf::OptInt#normalize (method)">#normalize</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="OptBase.html" title="Msf::OptBase (class)">OptBase</a></span></h3>
<p class="inherited"><span class='object_link'><a href="OptBase.html#advanced%3F-instance_method" title="Msf::OptBase#advanced? (method)">#advanced?</a></span>, <span class='object_link'><a href="OptBase.html#display_value-instance_method" title="Msf::OptBase#display_value (method)">#display_value</a></span>, <span class='object_link'><a href="OptBase.html#empty_required_value%3F-instance_method" title="Msf::OptBase#empty_required_value? (method)">#empty_required_value?</a></span>, <span class='object_link'><a href="OptBase.html#evasion%3F-instance_method" title="Msf::OptBase#evasion? (method)">#evasion?</a></span>, <span class='object_link'><a href="OptBase.html#initialize-instance_method" title="Msf::OptBase#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="OptBase.html#invalid_value_length%3F-instance_method" title="Msf::OptBase#invalid_value_length? (method)">#invalid_value_length?</a></span>, <span class='object_link'><a href="OptBase.html#normalize-instance_method" title="Msf::OptBase#normalize (method)">#normalize</a></span>, <span class='object_link'><a href="OptBase.html#required%3F-instance_method" title="Msf::OptBase#required? (method)">#required?</a></span>, <span class='object_link'><a href="OptBase.html#type%3F-instance_method" title="Msf::OptBase#type? (method)">#type?</a></span>, <span class='object_link'><a href="OptBase.html#validate_on_assignment%3F-instance_method" title="Msf::OptBase#validate_on_assignment? (method)">#validate_on_assignment?</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="OptBase.html#initialize-instance_method" title="Msf::OptBase#initialize (method)">Msf::OptBase</a></span></p>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="type-instance_method">
#<strong>type</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/opt_port.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>port</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="valid?-instance_method">
#<strong>valid?</strong>(value, check_empty: true, datastore: nil) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/opt_port.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>check_empty:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>datastore:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='id identifier rubyid_normalize'>normalize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>super</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_port'>port</span> <span class='op'>&lt;=</span> <span class='int'>65535</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_port'>port</span> <span class='op'>&gt;=</span> <span class='int'>0</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:18 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>