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

500 lines
12 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Msf::Exploit::Remote::NDMPSocket::NDMP::Message
&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::Remote::NDMPSocket::NDMP::Message";
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 (M)</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'><span class='object_link'><a href="../../../Remote.html" title="Msf::Exploit::Remote (class)">Remote</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../NDMPSocket.html" title="Msf::Exploit::Remote::NDMPSocket (module)">NDMPSocket</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../NDMP.html" title="Msf::Exploit::Remote::NDMPSocket::NDMP (module)">NDMP</a></span></span>
&raquo;
<span class="title">Message</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::Exploit::Remote::NDMPSocket::NDMP::Message
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Msf::Exploit::Remote::NDMPSocket::NDMP::Message</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/exploit/remote/ndmp_socket.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class represents a NDMP message, including its header and body.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Message/Header.html" title="Msf::Exploit::Remote::NDMPSocket::NDMP::Message::Header (class)">Header</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="CONFIG_GET_HOST_INFO-constant" class="">CONFIG_GET_HOST_INFO =
</dt>
<dd><pre class="code"><span class='int'>0x100</span></pre></dd>
<dt id="CONFIG_GET_BUTYPE_ATTR-constant" class="">CONFIG_GET_BUTYPE_ATTR =
</dt>
<dd><pre class="code"><span class='int'>0x101</span></pre></dd>
<dt id="CONFIG_GET_SERVER_INFO-constant" class="">CONFIG_GET_SERVER_INFO =
</dt>
<dd><pre class="code"><span class='int'>0x108</span></pre></dd>
<dt id="NOTIFY_CONNECTED-constant" class="">NOTIFY_CONNECTED =
</dt>
<dd><pre class="code"><span class='int'>0x502</span></pre></dd>
<dt id="CONNECT_OPEN-constant" class="">CONNECT_OPEN =
</dt>
<dd><pre class="code"><span class='int'>0x900</span></pre></dd>
<dt id="CONNECT_CLIENT_AUTH-constant" class="">CONNECT_CLIENT_AUTH =
</dt>
<dd><pre class="code"><span class='int'>0x901</span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#body-instance_method" title="#body (instance method)">#<strong>body</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#header-instance_method" title="#header (instance method)">#<strong>header</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute header.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#new_request-class_method" title="new_request (class method)">.<strong>new_request</strong>(type, body = &#39;&#39;) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(header, body) &#x21d2; Message </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Message.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(header, body) &#x21d2; <tt><span class='object_link'><a href="" title="Msf::Exploit::Remote::NDMPSocket::NDMP::Message (class)">Message</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Message.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/ndmp_socket.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_header'>header</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
<span class='ivar'>@header</span> <span class='op'>=</span> <span class='id identifier rubyid_header'>header</span>
<span class='ivar'>@body</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="body=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="body-instance_method">
#<strong>body</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute body.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/ndmp_socket.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_body'>body</span>
<span class='ivar'>@body</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="header=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="header-instance_method">
#<strong>header</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute header.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/ndmp_socket.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_header'>header</span>
<span class='ivar'>@header</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="new_request-class_method">
.<strong>new_request</strong>(type, body = &#39;&#39;) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37
38
39
40
41
42
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/ndmp_socket.rb', line 35</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new_request'>new_request</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_header'>header</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Message/Header.html" title="Msf::Exploit::Remote::NDMPSocket::NDMP::Message::Header (class)">Header</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Msf::Exploit::Remote::NDMPSocket::NDMP::Message#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='symbol'>:sequence_num</span> <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='symbol'>:timestamp</span> <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='symbol'>:is_response</span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='symbol'>:type</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span>
<span class='symbol'>:reply_sequence_num</span> <span class='op'>=&gt;</span> <span class='int'>0</span><span class='comma'>,</span>
<span class='symbol'>:error</span> <span class='op'>=&gt;</span> <span class='int'>0</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_header'>header</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:34 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>