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

973 lines
25 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>
Class: Rex::Logging::LogDispatcher
&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::Logging::LogDispatcher";
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 (L)</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="../Logging.html" title="Rex::Logging (module)">Logging</a></span></span>
&raquo;
<span class="title">LogDispatcher</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::Logging::LogDispatcher
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Rex::Logging::LogDispatcher</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rex/logging/log_dispatcher.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The log dispatcher associates log sources with log sinks. A log source is a unique identity that is associated with one and only one log sink. For instance, the framework-core registers the ‘core’</p>
</div>
</div>
<div class="tags">
</div>
<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="#log_levels-instance_method" title="#log_levels (instance method)">#<strong>log_levels</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>:nodoc:.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_sinks-instance_method" title="#log_sinks (instance method)">#<strong>log_sinks</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>:nodoc:.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_sinks_lock-instance_method" title="#log_sinks_lock (instance method)">#<strong>log_sinks_lock</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>:nodoc:.</p>
</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="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(src) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the sink that is associated with the supplied source.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#[]=-instance_method" title="#[]= (instance method)">#<strong>[]=</strong>(src, sink) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Calls the source association routie.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(src) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Removes a source association if one exists.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_level-instance_method" title="#get_level (instance method)">#<strong>get_level</strong>(src) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method returns the log level threshold of a given source.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; LogDispatcher </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Creates the global log dispatcher instance and initializes it for use.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log-instance_method" title="#log (instance method)">#<strong>log</strong>(sev, src, level, msg) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Performs the actual log operation against the supplied source.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#set_level-instance_method" title="#set_level (instance method)">#<strong>set_level</strong>(src, level) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method sets the log level threshold for a given source.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#store-instance_method" title="#store (instance method)">#<strong>store</strong>(src, sink, level = 0) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Associates the supplied source with the supplied sink.</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> &#x21d2; <tt><span class='object_link'><a href="" title="Rex::Logging::LogDispatcher (class)">LogDispatcher</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates the global log dispatcher instance and initializes it for use.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_sinks'>log_sinks</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_levels'>log_levels</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_sinks_lock'>log_sinks_lock</span> <span class='op'>=</span> <span class='const'>Mutex</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</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="log_levels=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="log_levels-instance_method">
#<strong>log_levels</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>:nodoc:</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
114
115
116</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 114</span>
<span class='kw'>def</span> <span class='id identifier rubyid_log_levels'>log_levels</span>
<span class='ivar'>@log_levels</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="log_sinks=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="log_sinks-instance_method">
#<strong>log_sinks</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>:nodoc:</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
113
114
115</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 113</span>
<span class='kw'>def</span> <span class='id identifier rubyid_log_sinks'>log_sinks</span>
<span class='ivar'>@log_sinks</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="log_sinks_lock=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="log_sinks_lock-instance_method">
#<strong>log_sinks_lock</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>:nodoc:</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
113
114
115</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 113</span>
<span class='kw'>def</span> <span class='id identifier rubyid_log_sinks_lock'>log_sinks_lock</span>
<span class='ivar'>@log_sinks_lock</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</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="[]-instance_method">
#<strong>[]</strong>(src) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the sink that is associated with the supplied source.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30
31
32
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 28</span>
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sink'>sink</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_log_sinks_lock'>log_sinks_lock</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_sink'>sink</span> <span class='op'>=</span> <span class='id identifier rubyid_log_sinks'>log_sinks</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span>
<span class='rbrace'>}</span>
<span class='kw'>return</span> <span class='id identifier rubyid_sink'>sink</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="[]=-instance_method">
#<strong>[]=</strong>(src, sink) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Calls the source association routie.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 41</span>
<span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_sink'>sink</span><span class='rparen'>)</span>
<span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_sink'>sink</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete-instance_method">
#<strong>delete</strong>(src) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Removes a source association if one exists.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sink'>sink</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_log_sinks_lock'>log_sinks_lock</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_sink'>sink</span> <span class='op'>=</span> <span class='id identifier rubyid_log_sinks'>log_sinks</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_log_sinks'>log_sinks</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</span>
<span class='rbrace'>}</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_sink'>sink</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sink'>sink</span><span class='period'>.</span><span class='id identifier rubyid_cleanup'>cleanup</span>
<span class='kw'>return</span> <span class='kw'>true</span>
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get_level-instance_method">
#<strong>get_level</strong>(src) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method returns the log level threshold of a given source.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
109
110
111</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 109</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_level'>get_level</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</span>
<span class='id identifier rubyid_log_levels'>log_levels</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../top-level-namespace.html#DEFAULT_LOG_LEVEL-constant" title="DEFAULT_LOG_LEVEL (constant)">DEFAULT_LOG_LEVEL</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="log-instance_method">
#<strong>log</strong>(sev, src, level, msg) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Performs the actual log operation against the supplied source</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91
92
93
94
95
96
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_log'>log</span><span class='lparen'>(</span><span class='id identifier rubyid_sev'>sev</span><span class='comma'>,</span> <span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_level'>level</span><span class='comma'>,</span> <span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
<span class='id identifier rubyid_log_sinks_lock'>log_sinks_lock</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='lbrace'>{</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='lparen'>(</span><span class='id identifier rubyid_sink'>sink</span> <span class='op'>=</span> <span class='id identifier rubyid_log_sinks'>log_sinks</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>next</span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_log_levels'>log_levels</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span> <span class='kw'>and</span> <span class='id identifier rubyid_level'>level</span> <span class='op'>&gt;</span> <span class='id identifier rubyid_log_levels'>log_levels</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sink'>sink</span><span class='period'>.</span><span class='id identifier rubyid_log'>log</span><span class='lparen'>(</span><span class='id identifier rubyid_sev'>sev</span><span class='comma'>,</span> <span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_level'>level</span><span class='comma'>,</span> <span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="set_level-instance_method">
#<strong>set_level</strong>(src, level) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method sets the log level threshold for a given source.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
102
103
104</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 102</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set_level'>set_level</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_level'>level</span><span class='rparen'>)</span>
<span class='id identifier rubyid_log_levels'>log_levels</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_level'>level</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="store-instance_method">
#<strong>store</strong>(src, sink, level = 0) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Associates the supplied source with the supplied sink. If a log level has already been defined for the source, the level argument is ignored. Use set_log_level to alter it.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52
53
54
55
56
57
58
59
60
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/logging/log_dispatcher.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_sink'>sink</span><span class='comma'>,</span> <span class='id identifier rubyid_level'>level</span> <span class='op'>=</span> <span class='int'>0</span><span class='rparen'>)</span>
<span class='id identifier rubyid_log_sinks_lock'>log_sinks_lock</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='lbrace'>{</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_log_sinks'>log_sinks</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_log_sinks'>log_sinks</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sink'>sink</span>
<span class='id identifier rubyid_set_log_level'><span class='object_link'><a href="../../top-level-namespace.html#set_log_level-instance_method" title="#set_log_level (method)">set_log_level</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_level'>level</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_log_levels'>log_levels</span><span class='lbracket'>[</span><span class='id identifier rubyid_src'>src</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span>
<span class='const'>RuntimeError</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The supplied log source </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_src'>src</span><span class='embexpr_end'>}</span><span class='tstring_content'> is already registered.</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='id identifier rubyid_caller'>caller</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:04: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>
Reference in New Issue View Git Blame Copy Permalink