adam/metasploit-gs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c3f5bd3de2d1affa01e2f6c2066c6bb0fc6413bc
metasploit-gs/api/Rex/Proto/Http/Response/OK.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

250 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Rex::Proto::Http::Response::OK
&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 = "Rex::Proto::Http::Response::OK";
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="../../../../Rex.html" title="Rex (module)">Rex</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Proto.html" title="Rex::Proto (module)">Proto</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Http.html" title="Rex::Proto::Http (module)">Http</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Response.html" title="Rex::Proto::Http::Response (class)">Response</a></span></span>
&raquo;
<span class="title">OK</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: Rex::Proto::Http::Response::OK
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Packet.html" title="Rex::Proto::Http::Packet (class)">Packet</a></span></li>
<li class="next"><span class='object_link'><a href="../Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></li>
<li class="next">Rex::Proto::Http::Response::OK</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rex/proto/http/response.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>HTTP 200/OK response class wrapper.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Response.html#code-instance_method" title="Rex::Proto::Http::Response#code (method)">#code</a></span>, <span class='object_link'><a href="../Response.html#count_100-instance_method" title="Rex::Proto::Http::Response#count_100 (method)">#count_100</a></span>, <span class='object_link'><a href="../Response.html#message-instance_method" title="Rex::Proto::Http::Response#message (method)">#message</a></span>, <span class='object_link'><a href="../Response.html#peerinfo-instance_method" title="Rex::Proto::Http::Response#peerinfo (method)">#peerinfo</a></span>, <span class='object_link'><a href="../Response.html#proto-instance_method" title="Rex::Proto::Http::Response#proto (method)">#proto</a></span>, <span class='object_link'><a href="../Response.html#request-instance_method" title="Rex::Proto::Http::Response#request (method)">#request</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Packet.html" title="Rex::Proto::Http::Packet (class)">Packet</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Packet.html#auto_cl-instance_method" title="Rex::Proto::Http::Packet#auto_cl (method)">#auto_cl</a></span>, <span class='object_link'><a href="../Packet.html#body-instance_method" title="Rex::Proto::Http::Packet#body (method)">#body</a></span>, <span class='object_link'><a href="../Packet.html#body_bytes_left-instance_method" title="Rex::Proto::Http::Packet#body_bytes_left (method)">#body_bytes_left</a></span>, <span class='object_link'><a href="../Packet.html#bufq-instance_method" title="Rex::Proto::Http::Packet#bufq (method)">#bufq</a></span>, <span class='object_link'><a href="../Packet.html#chunk_max_size-instance_method" title="Rex::Proto::Http::Packet#chunk_max_size (method)">#chunk_max_size</a></span>, <span class='object_link'><a href="../Packet.html#chunk_min_size-instance_method" title="Rex::Proto::Http::Packet#chunk_min_size (method)">#chunk_min_size</a></span>, <span class='object_link'><a href="../Packet.html#compress-instance_method" title="Rex::Proto::Http::Packet#compress (method)">#compress</a></span>, <span class='object_link'><a href="../Packet.html#error-instance_method" title="Rex::Proto::Http::Packet#error (method)">#error</a></span>, <span class='object_link'><a href="../Packet.html#headers-instance_method" title="Rex::Proto::Http::Packet#headers (method)">#headers</a></span>, <span class='object_link'><a href="../Packet.html#incomplete-instance_method" title="Rex::Proto::Http::Packet#incomplete (method)">#incomplete</a></span>, <span class='object_link'><a href="../Packet.html#inside_chunk-instance_method" title="Rex::Proto::Http::Packet#inside_chunk (method)">#inside_chunk</a></span>, <span class='object_link'><a href="../Packet.html#keepalive-instance_method" title="Rex::Proto::Http::Packet#keepalive (method)">#keepalive</a></span>, <span class='object_link'><a href="../Packet.html#max_data-instance_method" title="Rex::Proto::Http::Packet#max_data (method)">#max_data</a></span>, <span class='object_link'><a href="../Packet.html#state-instance_method" title="Rex::Proto::Http::Packet#state (method)">#state</a></span>, <span class='object_link'><a href="../Packet.html#transfer_chunked-instance_method" title="Rex::Proto::Http::Packet#transfer_chunked (method)">#transfer_chunked</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(message = &#39;OK&#39;, proto = DefaultProtocol) &#x21d2; OK </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of OK.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Response.html#check_100-instance_method" title="Rex::Proto::Http::Response#check_100 (method)">#check_100</a></span>, <span class='object_link'><a href="../Response.html#cmd_string-instance_method" title="Rex::Proto::Http::Response#cmd_string (method)">#cmd_string</a></span>, <span class='object_link'><a href="../Response.html#get_cookies-instance_method" title="Rex::Proto::Http::Response#get_cookies (method)">#get_cookies</a></span>, <span class='object_link'><a href="../Response.html#get_cookies_parsed-instance_method" title="Rex::Proto::Http::Response#get_cookies_parsed (method)">#get_cookies_parsed</a></span>, <span class='object_link'><a href="../Response.html#get_hidden_inputs-instance_method" title="Rex::Proto::Http::Response#get_hidden_inputs (method)">#get_hidden_inputs</a></span>, <span class='object_link'><a href="../Response.html#get_html_document-instance_method" title="Rex::Proto::Http::Response#get_html_document (method)">#get_html_document</a></span>, <span class='object_link'><a href="../Response.html#get_html_meta_elements-instance_method" title="Rex::Proto::Http::Response#get_html_meta_elements (method)">#get_html_meta_elements</a></span>, <span class='object_link'><a href="../Response.html#get_html_scripts-instance_method" title="Rex::Proto::Http::Response#get_html_scripts (method)">#get_html_scripts</a></span>, <span class='object_link'><a href="../Response.html#get_json_document-instance_method" title="Rex::Proto::Http::Response#get_json_document (method)">#get_json_document</a></span>, <span class='object_link'><a href="../Response.html#get_xml_document-instance_method" title="Rex::Proto::Http::Response#get_xml_document (method)">#get_xml_document</a></span>, <span class='object_link'><a href="../Response.html#gzip_decode-instance_method" title="Rex::Proto::Http::Response#gzip_decode (method)">#gzip_decode</a></span>, <span class='object_link'><a href="../Response.html#gzip_decode!-instance_method" title="Rex::Proto::Http::Response#gzip_decode! (method)">#gzip_decode!</a></span>, <span class='object_link'><a href="../Response.html#redirect%3F-instance_method" title="Rex::Proto::Http::Response#redirect? (method)">#redirect?</a></span>, <span class='object_link'><a href="../Response.html#redirection-instance_method" title="Rex::Proto::Http::Response#redirection (method)">#redirection</a></span>, <span class='object_link'><a href="../Response.html#update_cmd_parts-instance_method" title="Rex::Proto::Http::Response#update_cmd_parts (method)">#update_cmd_parts</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Packet.html" title="Rex::Proto::Http::Packet (class)">Packet</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Packet.html#[]-instance_method" title="Rex::Proto::Http::Packet#[] (method)">#[]</a></span>, <span class='object_link'><a href="../Packet.html#[]=-instance_method" title="Rex::Proto::Http::Packet#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="../Packet.html#check_100-instance_method" title="Rex::Proto::Http::Packet#check_100 (method)">#check_100</a></span>, <span class='object_link'><a href="../Packet.html#chunk-instance_method" title="Rex::Proto::Http::Packet#chunk (method)">#chunk</a></span>, <span class='object_link'><a href="../Packet.html#cmd_string-instance_method" title="Rex::Proto::Http::Packet#cmd_string (method)">#cmd_string</a></span>, <span class='object_link'><a href="../Packet.html#completed%3F-instance_method" title="Rex::Proto::Http::Packet#completed? (method)">#completed?</a></span>, <span class='object_link'><a href="../Packet.html#from_s-instance_method" title="Rex::Proto::Http::Packet#from_s (method)">#from_s</a></span>, <span class='object_link'><a href="../Packet.html#output_packet-instance_method" title="Rex::Proto::Http::Packet#output_packet (method)">#output_packet</a></span>, <span class='object_link'><a href="../Packet.html#parse-instance_method" title="Rex::Proto::Http::Packet#parse (method)">#parse</a></span>, <span class='object_link'><a href="../Packet.html#parse_body-instance_method" title="Rex::Proto::Http::Packet#parse_body (method)">#parse_body</a></span>, <span class='object_link'><a href="../Packet.html#parse_header-instance_method" title="Rex::Proto::Http::Packet#parse_header (method)">#parse_header</a></span>, <span class='object_link'><a href="../Packet.html#reset-instance_method" title="Rex::Proto::Http::Packet#reset (method)">#reset</a></span>, <span class='object_link'><a href="../Packet.html#reset_except_queue-instance_method" title="Rex::Proto::Http::Packet#reset_except_queue (method)">#reset_except_queue</a></span>, <span class='object_link'><a href="../Packet.html#to_s-instance_method" title="Rex::Proto::Http::Packet#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="../Packet.html#to_terminal_output-instance_method" title="Rex::Proto::Http::Packet#to_terminal_output (method)">#to_terminal_output</a></span>, <span class='object_link'><a href="../Packet.html#update_cmd_parts-instance_method" title="Rex::Proto::Http::Packet#update_cmd_parts (method)">#update_cmd_parts</a></span></p>
<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>(message = &#39;OK&#39;, proto = DefaultProtocol) &#x21d2; <tt><span class='object_link'><a href="" title="Rex::Proto::Http::Response::OK (class)">OK</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of OK.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/proto/http/response.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>OK</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_proto'>proto</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Http.html#DefaultProtocol-constant" title="Rex::Proto::Http::DefaultProtocol (constant)">DefaultProtocol</a></span></span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='int'>200</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_proto'>proto</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:04:15 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>
Reference in New Issue View Git Blame Copy Permalink