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

418 lines
12 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: Msf::RPC::JSON::Notification
&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::RPC::JSON::Notification";
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 (N)</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="../../RPC.html" title="Msf::RPC (module)">RPC</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../JSON.html" title="Msf::RPC::JSON (module)">JSON</a></span></span>
&raquo;
<span class="title">Notification</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::RPC::JSON::Notification
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Request.html" title="Msf::RPC::JSON::Request (class)">Request</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Request.html" title="Msf::RPC::JSON::Request (class)">Request</a></span></li>
<li class="next">Msf::RPC::JSON::Notification</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/rpc/json/request.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a JSON-RPC Notification. This is an EM::Deferrable class and instances respond to #callback and #errback to store callback actions.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants inherited
from <span class='object_link'><a href="Request.html" title="Msf::RPC::JSON::Request (class)">Request</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Request.html#JSON_MEDIA_TYPE-constant" title="Msf::RPC::JSON::Request::JSON_MEDIA_TYPE (constant)">Request::JSON_MEDIA_TYPE</a></span>, <span class='object_link'><a href="Request.html#JSON_RPC_ERROR_RESPONSE_MEMBER_TYPES-constant" title="Msf::RPC::JSON::Request::JSON_RPC_ERROR_RESPONSE_MEMBER_TYPES (constant)">Request::JSON_RPC_ERROR_RESPONSE_MEMBER_TYPES</a></span>, <span class='object_link'><a href="Request.html#JSON_RPC_ERROR_RESPONSE_REQUIRED_MEMBERS-constant" title="Msf::RPC::JSON::Request::JSON_RPC_ERROR_RESPONSE_REQUIRED_MEMBERS (constant)">Request::JSON_RPC_ERROR_RESPONSE_REQUIRED_MEMBERS</a></span>, <span class='object_link'><a href="Request.html#JSON_RPC_RESPONSE_MEMBER_TYPES-constant" title="Msf::RPC::JSON::Request::JSON_RPC_RESPONSE_MEMBER_TYPES (constant)">Request::JSON_RPC_RESPONSE_MEMBER_TYPES</a></span>, <span class='object_link'><a href="Request.html#JSON_RPC_RESPONSE_REQUIRED_MEMBERS-constant" title="Msf::RPC::JSON::Request::JSON_RPC_RESPONSE_REQUIRED_MEMBERS (constant)">Request::JSON_RPC_RESPONSE_REQUIRED_MEMBERS</a></span>, <span class='object_link'><a href="Request.html#JSON_RPC_VERSION-constant" title="Msf::RPC::JSON::Request::JSON_RPC_VERSION (constant)">Request::JSON_RPC_VERSION</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>(uri, api_token: nil, method:, params: nil, namespace: nil, symbolize_names: true, private_key_file: nil, cert_chain_file: nil, verify_peer: nil) &#x21d2; Notification </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Instantiate a Notification.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Request.html" title="Msf::RPC::JSON::Request (class)">Request</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Request.html#send-instance_method" title="Msf::RPC::JSON::Request#send (method)">#send</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>(uri, api_token: nil, method:, params: nil, namespace: nil, symbolize_names: true, private_key_file: nil, cert_chain_file: nil, verify_peer: nil) &#x21d2; <tt><span class='object_link'><a href="" title="Msf::RPC::JSON::Notification (class)">Notification</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Instantiate a Notification.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>uri</span>
<span class='type'>(<tt>URI::HTTP</tt>)</span>
&mdash;
<div class='inline'>
<p>the JSON-RPC service URI</p>
</div>
</li>
<li>
<span class='name'>api_token</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the API token. Default: nil</p>
</div>
</li>
<li>
<span class='name'>method</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the JSON-RPC method name.</p>
</div>
</li>
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Array</tt>, <tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the JSON-RPC method parameters. Default: nil</p>
</div>
</li>
<li>
<span class='name'>namespace</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the namespace for the JSON-RPC method. The namespace will be prepended to the method name with a period separator. Default: nil</p>
</div>
</li>
<li>
<span class='name'>symbolize_names</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>If true, symbols are used for the names (keys) when processing JSON objects; otherwise, strings are used. Default: true</p>
</div>
</li>
<li>
<span class='name'>private_key_file</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the SSL private key file used for the HTTPS request. Default: nil</p>
</div>
</li>
<li>
<span class='name'>cert_chain_file</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the SSL cert chain file used for the HTTPS request. Default: nil</p>
</div>
</li>
<li>
<span class='name'>verify_peer</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>indicates whether a server should request a certificate from a peer, to be verified by user code. Default: nil</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
211
212
213
214
215
216
217
218
219
220
221
222
223
224</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/json/request.rb', line 211</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'><span class='object_link'><a href="../../../top-level-namespace.html#uri-instance_method" title="#uri (method)">uri</a></span></span><span class='comma'>,</span> <span class='label'>api_token:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>method:</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>namespace:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>private_key_file:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>cert_chain_file:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>verify_peer:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'><span class='object_link'><a href="../../../top-level-namespace.html#uri-instance_method" title="#uri (method)">uri</a></span></span><span class='comma'>,</span>
<span class='label'>api_token:</span> <span class='id identifier rubyid_api_token'>api_token</span><span class='comma'>,</span>
<span class='label'>method:</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span>
<span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span>
<span class='label'>namespace:</span> <span class='id identifier rubyid_namespace'>namespace</span><span class='comma'>,</span>
<span class='label'>symbolize_names:</span> <span class='id identifier rubyid_symbolize_names'>symbolize_names</span><span class='comma'>,</span>
<span class='label'>is_notification:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>private_key_file:</span> <span class='id identifier rubyid_private_key_file'>private_key_file</span><span class='comma'>,</span>
<span class='label'>cert_chain_file:</span> <span class='id identifier rubyid_cert_chain_file'>cert_chain_file</span><span class='comma'>,</span>
<span class='label'>verify_peer:</span> <span class='id identifier rubyid_verify_peer'>verify_peer</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:27 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