1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Net::SSH::Loggable - net-ssh 4.1.0.rc1</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
</script>
<script src="../../js/jquery.js"></script>
<script src="../../js/darkfish.js"></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-debug">#debug</a>
<li ><a href="#method-i-error">#error</a>
<li ><a href="#method-i-fatal">#fatal</a>
<li ><a href="#method-i-info">#info</a>
<li ><a href="#method-i-lwarn">#lwarn</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Net::SSH::Loggable">
<h1 id="module-Net::SSH::Loggable" class="module">
module Net::SSH::Loggable
</h1>
<section class="description">
<p>A simple module to make logging easier to deal with. It assumes that the
logger instance (if not nil) quacks like a Logger object (in Ruby's
standard library). Although used primarily internally by <a
href="../SSH.html">Net::SSH</a>, it can easily be used to add Net::SSH-like
logging to your own programs.</p>
<pre>class MyClass
include Net::SSH::Loggable
end
Net::SSH.start(...) do |ssh|
obj = MyClass.new
obj.logger = ssh.logger
...
end</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-logger" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">logger</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The logger instance that will be used to log messages. If nil, nothing will
be logged.</p>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-debug" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays the result of yielding if the log level is Logger::DEBUG or
greater.</p>
<div class="method-source-code" id="debug-source">
<pre><span class="ruby-comment"># File lib/net/ssh/loggable.rb, line 24</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">debug</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword">yield</span> } <span class="ruby-keyword">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-error" class="method-detail ">
<div class="method-heading">
<span class="method-name">error</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays the result of yielding if the log level is Logger:ERROR or
greater.</p>
<div class="method-source-code" id="error-source">
<pre><span class="ruby-comment"># File lib/net/ssh/loggable.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">error</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">ERROR</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword">yield</span> } <span class="ruby-keyword">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">error?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fatal" class="method-detail ">
<div class="method-heading">
<span class="method-name">fatal</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays the result of yielding if the log level is Logger::FATAL or
greater.</p>
<div class="method-source-code" id="fatal-source">
<pre><span class="ruby-comment"># File lib/net/ssh/loggable.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">fatal</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">FATAL</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword">yield</span> } <span class="ruby-keyword">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">fatal?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-info" class="method-detail ">
<div class="method-heading">
<span class="method-name">info</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays the result of yielding if the log level is Logger::INFO or
greater.</p>
<div class="method-source-code" id="info-source">
<pre><span class="ruby-comment"># File lib/net/ssh/loggable.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">info</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">INFO</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword">yield</span> } <span class="ruby-keyword">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">info?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-lwarn" class="method-detail ">
<div class="method-heading">
<span class="method-name">lwarn</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays the result of yielding if the log level is Logger::WARN or
greater. (Called lwarn to avoid shadowing with Kernel#warn.)</p>
<div class="method-source-code" id="lwarn-source">
<pre><span class="ruby-comment"># File lib/net/ssh/loggable.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">lwarn</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">WARN</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword">yield</span> } <span class="ruby-keyword">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">warn?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
