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

579 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Msf::DatabaseEvent
&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::DatabaseEvent";
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 (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span>
&raquo;
<span class="title">DatabaseEvent</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::DatabaseEvent
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Plugin/EventLibnotify.html" title="Msf::Plugin::EventLibnotify (class)">Plugin::EventLibnotify</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/database_event.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Events that can occur in the host/service database.</p>
</div>
</div>
<div class="tags">
</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="#on_db_client-instance_method" title="#on_db_client (instance method)">#<strong>on_db_client</strong>(client) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when a new client is added to the database.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_db_host-instance_method" title="#on_db_host (instance method)">#<strong>on_db_host</strong>(host) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when a new host is added to the database.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_db_host_state-instance_method" title="#on_db_host_state (instance method)">#<strong>on_db_host_state</strong>(host, ostate) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when an existing host’s state changes.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_db_ref-instance_method" title="#on_db_ref (instance method)">#<strong>on_db_ref</strong>(ref) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when a new reference is created.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_db_service-instance_method" title="#on_db_service (instance method)">#<strong>on_db_service</strong>(service) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when a new service is added to the database.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_db_service_state-instance_method" title="#on_db_service_state (instance method)">#<strong>on_db_service_state</strong>(host, port, ostate) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when an existing service’s state changes.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_db_vuln-instance_method" title="#on_db_vuln (instance method)">#<strong>on_db_vuln</strong>(vuln) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when an applicable vulnerability is found for a service.</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="on_db_client-instance_method">
#<strong>on_db_client</strong>(client) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when a new client is added to the database. The client parameter is of type Client.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/database_event.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_db_client'>on_db_client</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_db_host-instance_method">
#<strong>on_db_host</strong>(host) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when a new host is added to the database. The host parameter is of type Host.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/database_event.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_db_host'>on_db_host</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_db_host_state-instance_method">
#<strong>on_db_host_state</strong>(host, ostate) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when an existing host’s state changes</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/database_event.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_db_host_state'>on_db_host_state</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_ostate'>ostate</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_db_ref-instance_method">
#<strong>on_db_ref</strong>(ref) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when a new reference is created.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/database_event.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_db_ref'>on_db_ref</span><span class='lparen'>(</span><span class='id identifier rubyid_ref'>ref</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_db_service-instance_method">
#<strong>on_db_service</strong>(service) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when a new service is added to the database. The service parameter is of type Service.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/database_event.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_db_service'>on_db_service</span><span class='lparen'>(</span><span class='id identifier rubyid_service'>service</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_db_service_state-instance_method">
#<strong>on_db_service_state</strong>(host, port, ostate) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when an existing service’s state changes</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/database_event.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_db_service_state'>on_db_service_state</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span> <span class='id identifier rubyid_ostate'>ostate</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_db_vuln-instance_method">
#<strong>on_db_vuln</strong>(vuln) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when an applicable vulnerability is found for a service. The vuln parameter is of type Vuln.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/database_event.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_db_vuln'>on_db_vuln</span><span class='lparen'>(</span><span class='id identifier rubyid_vuln'>vuln</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:01:07 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