log4r 1.1.6 → 1.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README +3 -3
- data/Rakefile +2 -2
- data/doc/rdoc/Log4r.html +519 -0
- data/doc/rdoc/Log4r/BasicFormatter.html +388 -0
- data/doc/rdoc/Log4r/ConfigError.html +225 -0
- data/doc/rdoc/Log4r/Configurator.html +1068 -0
- data/doc/rdoc/Log4r/DateFileOutputter.html +479 -0
- data/doc/rdoc/Log4r/DefaultFormatter.html +223 -0
- data/doc/rdoc/Log4r/EmailOutputter.html +654 -0
- data/doc/rdoc/Log4r/FileOutputter.html +346 -0
- data/doc/rdoc/Log4r/Formatter.html +309 -0
- data/doc/rdoc/Log4r/GDC.html +346 -0
- data/doc/rdoc/Log4r/GDC_rb.html +80 -0
- data/doc/rdoc/Log4r/IOOutputter.html +410 -0
- data/doc/rdoc/Log4r/Log4jXmlFormatter.html +337 -0
- data/doc/rdoc/Log4r/Log4rConfig.html +211 -0
- data/doc/rdoc/Log4r/Log4rTools.html +388 -0
- data/doc/rdoc/Log4r/LogEvent.html +378 -0
- data/doc/rdoc/Log4r/LogServer.html +340 -0
- data/doc/rdoc/Log4r/Logger.html +1150 -0
- data/doc/rdoc/Log4r/Logger/LoggerFactory.html +218 -0
- data/doc/rdoc/Log4r/Logger/Repository.html +225 -0
- data/doc/rdoc/Log4r/MDC.html +424 -0
- data/doc/rdoc/Log4r/MDC_rb.html +83 -0
- data/doc/rdoc/Log4r/NDC.html +632 -0
- data/doc/rdoc/Log4r/NDC_rb.html +110 -0
- data/doc/rdoc/Log4r/ObjectFormatter.html +280 -0
- data/doc/rdoc/Log4r/Outputter.html +934 -0
- data/doc/rdoc/Log4r/Outputter/OutputterFactory.html +218 -0
- data/doc/rdoc/Log4r/Outputter/consoleoutputters_rb.html +57 -0
- data/doc/rdoc/Log4r/Outputter/datefileoutputter_rb.html +93 -0
- data/doc/rdoc/Log4r/Outputter/emailoutputter_rb.html +179 -0
- data/doc/rdoc/Log4r/Outputter/fileoutputter_rb.html +64 -0
- data/doc/rdoc/Log4r/Outputter/iooutputter_rb.html +59 -0
- data/doc/rdoc/Log4r/Outputter/outputter_rb.html +222 -0
- data/doc/rdoc/Log4r/Outputter/outputterfactory_rb.html +62 -0
- data/doc/rdoc/Log4r/Outputter/remoteoutputter_rb.html +59 -0
- data/doc/rdoc/Log4r/Outputter/rollingfileoutputter_rb.html +66 -0
- data/doc/rdoc/Log4r/Outputter/staticoutputter_rb.html +55 -0
- data/doc/rdoc/Log4r/Outputter/syslogoutputter_rb.html +110 -0
- data/doc/rdoc/Log4r/Outputter/udpoutputter_rb.html +220 -0
- data/doc/rdoc/Log4r/PatternFormatter.html +404 -0
- data/doc/rdoc/Log4r/ROMPClient.html +211 -0
- data/doc/rdoc/Log4r/ROMPServer.html +211 -0
- data/doc/rdoc/Log4r/RemoteOutputter.html +402 -0
- data/doc/rdoc/Log4r/RollingFileOutputter.html +551 -0
- data/doc/rdoc/Log4r/RootLogger.html +530 -0
- data/doc/rdoc/Log4r/SimpleFormatter.html +276 -0
- data/doc/rdoc/Log4r/StderrOutputter.html +268 -0
- data/doc/rdoc/Log4r/StdoutOutputter.html +268 -0
- data/doc/rdoc/Log4r/SyslogOutputter.html +551 -0
- data/doc/rdoc/Log4r/UDPOutputter.html +379 -0
- data/doc/rdoc/Log4r/YamlConfigurator.html +966 -0
- data/doc/rdoc/Log4r/base_rb.html +57 -0
- data/doc/rdoc/Log4r/config_rb.html +122 -0
- data/doc/rdoc/Log4r/configurator_rb.html +370 -0
- data/doc/rdoc/Log4r/formatter/formatter_rb.html +121 -0
- data/doc/rdoc/Log4r/formatter/log4jxmlformatter_rb.html +64 -0
- data/doc/rdoc/Log4r/formatter/patternformatter_rb.html +239 -0
- data/doc/rdoc/Log4r/lib/drbloader_rb.html +57 -0
- data/doc/rdoc/Log4r/lib/xmlloader_rb.html +57 -0
- data/doc/rdoc/Log4r/logevent_rb.html +55 -0
- data/doc/rdoc/Log4r/logger_rb.html +293 -0
- data/doc/rdoc/Log4r/loggerfactory_rb.html +66 -0
- data/doc/rdoc/Log4r/logserver_rb.html +161 -0
- data/doc/rdoc/Log4r/rdoc/GDC.html +175 -0
- data/doc/rdoc/Log4r/rdoc/MDC.html +178 -0
- data/doc/rdoc/Log4r/rdoc/NDC.html +207 -0
- data/doc/rdoc/Log4r/rdoc/configurator.html +462 -0
- data/doc/rdoc/Log4r/rdoc/emailoutputter.html +279 -0
- data/doc/rdoc/Log4r/rdoc/formatter.html +218 -0
- data/doc/rdoc/Log4r/rdoc/log4r.html +286 -0
- data/doc/rdoc/Log4r/rdoc/logger.html +382 -0
- data/doc/rdoc/Log4r/rdoc/logserver.html +265 -0
- data/doc/rdoc/Log4r/rdoc/outputter.html +313 -0
- data/doc/rdoc/Log4r/rdoc/patternformatter.html +331 -0
- data/doc/rdoc/Log4r/rdoc/syslogoutputter.html +197 -0
- data/doc/rdoc/Log4r/rdoc/win32eventoutputter.html +165 -0
- data/doc/rdoc/Log4r/rdoc/yamlconfigurator.html +187 -0
- data/doc/rdoc/Log4r/repository_rb.html +74 -0
- data/doc/rdoc/Log4r/staticlogger_rb.html +55 -0
- data/doc/rdoc/Log4r/yamlconfigurator_rb.html +95 -0
- data/doc/rdoc/REXML.html +211 -0
- data/doc/rdoc/created.rid +1 -0
- data/doc/rdoc/images/brick.png +0 -0
- data/doc/rdoc/images/brick_link.png +0 -0
- data/doc/rdoc/images/bug.png +0 -0
- data/doc/rdoc/images/bullet_black.png +0 -0
- data/doc/rdoc/images/bullet_toggle_minus.png +0 -0
- data/doc/rdoc/images/bullet_toggle_plus.png +0 -0
- data/doc/rdoc/images/date.png +0 -0
- data/doc/rdoc/images/find.png +0 -0
- data/doc/rdoc/images/loadingAnimation.gif +0 -0
- data/doc/rdoc/images/macFFBgHack.png +0 -0
- data/doc/rdoc/images/package.png +0 -0
- data/doc/rdoc/images/page_green.png +0 -0
- data/doc/rdoc/images/page_white_text.png +0 -0
- data/doc/rdoc/images/page_white_width.png +0 -0
- data/doc/rdoc/images/plugin.png +0 -0
- data/doc/rdoc/images/ruby.png +0 -0
- data/doc/rdoc/images/tag_green.png +0 -0
- data/doc/rdoc/images/wrench.png +0 -0
- data/doc/rdoc/images/wrench_orange.png +0 -0
- data/doc/rdoc/images/zoom.png +0 -0
- data/doc/rdoc/index.html +585 -0
- data/doc/rdoc/js/darkfish.js +116 -0
- data/doc/rdoc/js/jquery.js +32 -0
- data/doc/rdoc/js/quicksearch.js +114 -0
- data/doc/rdoc/js/thickbox-compressed.js +10 -0
- data/doc/rdoc/log4r-rdoc.css +696 -0
- data/doc/rdoc/log4r_rb.html +207 -0
- data/doc/rdoc/rdoc.css +696 -0
- data/examples/rdoc-gen +2 -0
- data/src/log4r.rb +2 -2
- data/src/log4r/formatter/patternformatter.rb +15 -15
- data/src/log4r/outputter/udpoutputter.rb +4 -4
- data/tests/testchainsaw.rb +1 -1
- metadata +123 -8
- data/src/log4r/outputter/datefileoutputter.patch +0 -24
- data/src/log4r/outputter/diff +0 -14
- data/src/log4r/outputter/new-datefileoutputter.rb +0 -117
|
@@ -0,0 +1,551 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
|
7
|
+
|
|
8
|
+
<title>Class: Log4r::RollingFileOutputter</title>
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
|
|
11
|
+
|
|
12
|
+
<script src="../js/jquery.js" type="text/javascript"
|
|
13
|
+
charset="utf-8"></script>
|
|
14
|
+
<script src="../js/thickbox-compressed.js" type="text/javascript"
|
|
15
|
+
charset="utf-8"></script>
|
|
16
|
+
<script src="../js/quicksearch.js" type="text/javascript"
|
|
17
|
+
charset="utf-8"></script>
|
|
18
|
+
<script src="../js/darkfish.js" type="text/javascript"
|
|
19
|
+
charset="utf-8"></script>
|
|
20
|
+
|
|
21
|
+
</head>
|
|
22
|
+
<body class="class">
|
|
23
|
+
|
|
24
|
+
<div id="metadata">
|
|
25
|
+
<div id="file-metadata">
|
|
26
|
+
<div id="file-list-section" class="section">
|
|
27
|
+
<h3 class="section-header">In Files</h3>
|
|
28
|
+
<div class="section-body">
|
|
29
|
+
<ul>
|
|
30
|
+
|
|
31
|
+
<li><a href="../log4r/outputter/rollingfileoutputter_rb.html?TB_iframe=true&height=550&width=785"
|
|
32
|
+
class="thickbox" title="log4r/outputter/rollingfileoutputter.rb">log4r/outputter/rollingfileoutputter.rb</a></li>
|
|
33
|
+
|
|
34
|
+
</ul>
|
|
35
|
+
</div>
|
|
36
|
+
</div>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="class-metadata">
|
|
42
|
+
|
|
43
|
+
<!-- Parent Class -->
|
|
44
|
+
|
|
45
|
+
<div id="parent-class-section" class="section">
|
|
46
|
+
<h3 class="section-header">Parent</h3>
|
|
47
|
+
|
|
48
|
+
<p class="link">FileOutputter</p>
|
|
49
|
+
|
|
50
|
+
</div>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
<!-- Namespace Contents -->
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
<!-- Method Quickref -->
|
|
57
|
+
|
|
58
|
+
<div id="method-list-section" class="section">
|
|
59
|
+
<h3 class="section-header">Methods</h3>
|
|
60
|
+
<ul class="link-list">
|
|
61
|
+
|
|
62
|
+
<li><a href="#M000112">::new</a></li>
|
|
63
|
+
|
|
64
|
+
<li><a href="#M000114">#makeNewFilename</a></li>
|
|
65
|
+
|
|
66
|
+
<li><a href="#M000119">#requiresRoll</a></li>
|
|
67
|
+
|
|
68
|
+
<li><a href="#M000120">#roll</a></li>
|
|
69
|
+
|
|
70
|
+
<li><a href="#M000113">#write</a></li>
|
|
71
|
+
|
|
72
|
+
</ul>
|
|
73
|
+
</div>
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<!-- Included Modules -->
|
|
77
|
+
|
|
78
|
+
</div>
|
|
79
|
+
|
|
80
|
+
<div id="project-metadata">
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
<div id="fileindex-section" class="section project-section">
|
|
84
|
+
<h3 class="section-header">Files</h3>
|
|
85
|
+
<ul>
|
|
86
|
+
|
|
87
|
+
<li class="file"><a href="../log4r/rdoc/GDC.html">GDC</a></li>
|
|
88
|
+
|
|
89
|
+
<li class="file"><a href="../log4r/rdoc/MDC.html">MDC</a></li>
|
|
90
|
+
|
|
91
|
+
<li class="file"><a href="../log4r/rdoc/NDC.html">NDC</a></li>
|
|
92
|
+
|
|
93
|
+
<li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
|
|
94
|
+
|
|
95
|
+
<li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
|
|
96
|
+
|
|
97
|
+
<li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
|
|
98
|
+
|
|
99
|
+
<li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
|
|
100
|
+
|
|
101
|
+
<li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
|
|
102
|
+
|
|
103
|
+
<li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
|
|
104
|
+
|
|
105
|
+
<li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
|
|
106
|
+
|
|
107
|
+
<li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
|
|
108
|
+
|
|
109
|
+
<li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
|
|
110
|
+
|
|
111
|
+
<li class="file"><a href="../log4r/rdoc/win32eventoutputter.html">win32eventoutputter</a></li>
|
|
112
|
+
|
|
113
|
+
<li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
|
|
114
|
+
|
|
115
|
+
</ul>
|
|
116
|
+
</div>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<div id="classindex-section" class="section project-section">
|
|
120
|
+
<h3 class="section-header">Class Index
|
|
121
|
+
<span class="search-toggle"><img src="../images/find.png"
|
|
122
|
+
height="16" width="16" alt="[+]"
|
|
123
|
+
title="show/hide quicksearch" /></span></h3>
|
|
124
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
125
|
+
<fieldset>
|
|
126
|
+
<legend>Quicksearch</legend>
|
|
127
|
+
<input type="text" name="quicksearch" value=""
|
|
128
|
+
class="quicksearch-field" />
|
|
129
|
+
</fieldset>
|
|
130
|
+
</form>
|
|
131
|
+
|
|
132
|
+
<ul class="link-list">
|
|
133
|
+
|
|
134
|
+
<li><a href="../Log4r.html">Log4r</a></li>
|
|
135
|
+
|
|
136
|
+
<li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
|
|
137
|
+
|
|
138
|
+
<li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
|
|
139
|
+
|
|
140
|
+
<li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
|
|
141
|
+
|
|
142
|
+
<li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
|
|
143
|
+
|
|
144
|
+
<li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
|
|
145
|
+
|
|
146
|
+
<li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
|
|
147
|
+
|
|
148
|
+
<li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
|
|
149
|
+
|
|
150
|
+
<li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
|
|
151
|
+
|
|
152
|
+
<li><a href="../Log4r/GDC.html">Log4r::GDC</a></li>
|
|
153
|
+
|
|
154
|
+
<li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
|
|
155
|
+
|
|
156
|
+
<li><a href="../Log4r/Log4jXmlFormatter.html">Log4r::Log4jXmlFormatter</a></li>
|
|
157
|
+
|
|
158
|
+
<li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
|
|
159
|
+
|
|
160
|
+
<li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
|
|
161
|
+
|
|
162
|
+
<li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
|
|
163
|
+
|
|
164
|
+
<li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
|
|
165
|
+
|
|
166
|
+
<li><a href="../Log4r/MDC.html">Log4r::MDC</a></li>
|
|
167
|
+
|
|
168
|
+
<li><a href="../Log4r/NDC.html">Log4r::NDC</a></li>
|
|
169
|
+
|
|
170
|
+
<li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
|
|
171
|
+
|
|
172
|
+
<li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
|
|
173
|
+
|
|
174
|
+
<li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
|
|
175
|
+
|
|
176
|
+
<li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
|
|
177
|
+
|
|
178
|
+
<li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
|
|
179
|
+
|
|
180
|
+
<li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
|
|
181
|
+
|
|
182
|
+
<li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
|
|
183
|
+
|
|
184
|
+
<li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
|
|
185
|
+
|
|
186
|
+
<li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
|
|
187
|
+
|
|
188
|
+
<li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
|
|
189
|
+
|
|
190
|
+
<li><a href="../Log4r/UDPOutputter.html">Log4r::UDPOutputter</a></li>
|
|
191
|
+
|
|
192
|
+
<li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
|
|
193
|
+
|
|
194
|
+
</ul>
|
|
195
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
196
|
+
</div>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
</div>
|
|
200
|
+
</div>
|
|
201
|
+
|
|
202
|
+
<div id="documentation">
|
|
203
|
+
<h1 class="class">Log4r::RollingFileOutputter</h1>
|
|
204
|
+
|
|
205
|
+
<div id="description">
|
|
206
|
+
<p>
|
|
207
|
+
<a href="RollingFileOutputter.html">RollingFileOutputter</a> - subclass of
|
|
208
|
+
<a href="FileOutputter.html">FileOutputter</a> that rolls files on size or
|
|
209
|
+
time. Additional hash arguments are:
|
|
210
|
+
</p>
|
|
211
|
+
<dl>
|
|
212
|
+
<dt><tt>:maxsize</tt></dt><dd>Maximum size of the file in bytes.
|
|
213
|
+
|
|
214
|
+
</dd>
|
|
215
|
+
<dt><tt>:trunc</tt></dt><dd>Maximum age of the file in seconds.
|
|
216
|
+
|
|
217
|
+
</dd>
|
|
218
|
+
</dl>
|
|
219
|
+
|
|
220
|
+
</div>
|
|
221
|
+
|
|
222
|
+
<!-- Constants -->
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<!-- Attributes -->
|
|
226
|
+
|
|
227
|
+
<div id="attribute-method-details" class="method-section section">
|
|
228
|
+
<h3 class="section-header">Attributes</h3>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<div id="count-attribute-method" class="method-detail">
|
|
232
|
+
<a name="count"></a>
|
|
233
|
+
|
|
234
|
+
<div class="method-heading attribute-method-heading">
|
|
235
|
+
<span class="method-name">count</span><span
|
|
236
|
+
class="attribute-access-type">[R]</span>
|
|
237
|
+
</div>
|
|
238
|
+
|
|
239
|
+
<div class="method-description">
|
|
240
|
+
|
|
241
|
+
<p class="missing-docs">(Not documented)</p>
|
|
242
|
+
|
|
243
|
+
</div>
|
|
244
|
+
</div>
|
|
245
|
+
|
|
246
|
+
<div id="maxsize-attribute-method" class="method-detail">
|
|
247
|
+
<a name="maxsize"></a>
|
|
248
|
+
|
|
249
|
+
<div class="method-heading attribute-method-heading">
|
|
250
|
+
<span class="method-name">maxsize</span><span
|
|
251
|
+
class="attribute-access-type">[R]</span>
|
|
252
|
+
</div>
|
|
253
|
+
|
|
254
|
+
<div class="method-description">
|
|
255
|
+
|
|
256
|
+
<p class="missing-docs">(Not documented)</p>
|
|
257
|
+
|
|
258
|
+
</div>
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
<div id="maxtime-attribute-method" class="method-detail">
|
|
262
|
+
<a name="maxtime"></a>
|
|
263
|
+
|
|
264
|
+
<div class="method-heading attribute-method-heading">
|
|
265
|
+
<span class="method-name">maxtime</span><span
|
|
266
|
+
class="attribute-access-type">[R]</span>
|
|
267
|
+
</div>
|
|
268
|
+
|
|
269
|
+
<div class="method-description">
|
|
270
|
+
|
|
271
|
+
<p class="missing-docs">(Not documented)</p>
|
|
272
|
+
|
|
273
|
+
</div>
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
<div id="start-ime-attribute-method" class="method-detail">
|
|
277
|
+
<a name="startTime"></a>
|
|
278
|
+
|
|
279
|
+
<div class="method-heading attribute-method-heading">
|
|
280
|
+
<span class="method-name">startTime</span><span
|
|
281
|
+
class="attribute-access-type">[R]</span>
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
<div class="method-description">
|
|
285
|
+
|
|
286
|
+
<p class="missing-docs">(Not documented)</p>
|
|
287
|
+
|
|
288
|
+
</div>
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<!-- Methods -->
|
|
295
|
+
|
|
296
|
+
<div id="public-class-method-details" class="method-section section">
|
|
297
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
<div id="new-method" class="method-detail ">
|
|
301
|
+
<a name="M000112"></a>
|
|
302
|
+
|
|
303
|
+
<div class="method-heading">
|
|
304
|
+
|
|
305
|
+
<span class="method-name">new</span><span
|
|
306
|
+
class="method-args">(_name, hash={})</span>
|
|
307
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
308
|
+
|
|
309
|
+
</div>
|
|
310
|
+
|
|
311
|
+
<div class="method-description">
|
|
312
|
+
|
|
313
|
+
<p class="missing-docs">(Not documented)</p>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
<div class="method-source-code"
|
|
318
|
+
id="new-source">
|
|
319
|
+
<pre>
|
|
320
|
+
<span class="ruby-comment cmt"># File log4r/outputter/rollingfileoutputter.rb, line 19</span>
|
|
321
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-identifier">hash</span>={})
|
|
322
|
+
<span class="ruby-ivar">@count</span> = <span class="ruby-value">0</span>
|
|
323
|
+
<span class="ruby-keyword kw">super</span>( <span class="ruby-identifier">_name</span>, <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-identifier">:create</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>}) )
|
|
324
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">:maxsize</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value str">'maxsize'</span>)
|
|
325
|
+
<span class="ruby-identifier">_maxsize</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:maxsize</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'maxsize'</span>]).<span class="ruby-identifier">to_i</span>
|
|
326
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_maxsize</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">Fixnum</span>
|
|
327
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-value str">"Argument 'maxsize' must be an Fixnum"</span>, <span class="ruby-identifier">caller</span>
|
|
328
|
+
<span class="ruby-keyword kw">end</span>
|
|
329
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_maxsize</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
|
330
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-value str">"Argument 'maxsize' must be > 0"</span>, <span class="ruby-identifier">caller</span>
|
|
331
|
+
<span class="ruby-keyword kw">end</span>
|
|
332
|
+
<span class="ruby-ivar">@maxsize</span> = <span class="ruby-identifier">_maxsize</span>
|
|
333
|
+
<span class="ruby-keyword kw">end</span>
|
|
334
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">:maxtime</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value str">'maxtime'</span>)
|
|
335
|
+
<span class="ruby-identifier">_maxtime</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:maxtime</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'maxtime'</span>]).<span class="ruby-identifier">to_i</span>
|
|
336
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_maxtime</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">Fixnum</span>
|
|
337
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-value str">"Argument 'maxtime' must be an Fixnum"</span>, <span class="ruby-identifier">caller</span>
|
|
338
|
+
<span class="ruby-keyword kw">end</span>
|
|
339
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_maxtime</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
|
340
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-value str">"Argument 'maxtime' must be > 0"</span>, <span class="ruby-identifier">caller</span>
|
|
341
|
+
<span class="ruby-keyword kw">end</span>
|
|
342
|
+
<span class="ruby-ivar">@maxtime</span> = <span class="ruby-identifier">_maxtime</span>
|
|
343
|
+
<span class="ruby-ivar">@startTime</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
|
|
344
|
+
<span class="ruby-keyword kw">end</span>
|
|
345
|
+
<span class="ruby-ivar">@baseFilename</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-ivar">@filename</span>)
|
|
346
|
+
<span class="ruby-comment cmt"># roll immediately so all files are of the form "000001-@baseFilename"</span>
|
|
347
|
+
<span class="ruby-identifier">roll</span>
|
|
348
|
+
<span class="ruby-comment cmt"># initialize the file size counter</span>
|
|
349
|
+
<span class="ruby-ivar">@datasize</span> = <span class="ruby-value">0</span>
|
|
350
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
351
|
+
</div>
|
|
352
|
+
|
|
353
|
+
</div>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</div>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
</div>
|
|
360
|
+
|
|
361
|
+
<div id="private-instance-method-details" class="method-section section">
|
|
362
|
+
<h3 class="section-header">Private Instance Methods</h3>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
<div id="make-ew-ilename-method" class="method-detail ">
|
|
366
|
+
<a name="M000114"></a>
|
|
367
|
+
|
|
368
|
+
<div class="method-heading">
|
|
369
|
+
|
|
370
|
+
<span class="method-name">makeNewFilename</span><span
|
|
371
|
+
class="method-args">()</span>
|
|
372
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
373
|
+
|
|
374
|
+
</div>
|
|
375
|
+
|
|
376
|
+
<div class="method-description">
|
|
377
|
+
|
|
378
|
+
<p>
|
|
379
|
+
construct a new filename from the count and baseFilname
|
|
380
|
+
</p>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<div class="method-source-code"
|
|
385
|
+
id="make-ew-ilename-source">
|
|
386
|
+
<pre>
|
|
387
|
+
<span class="ruby-comment cmt"># File log4r/outputter/rollingfileoutputter.rb, line 64</span>
|
|
388
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">makeNewFilename</span>
|
|
389
|
+
<span class="ruby-comment cmt"># note use of hard coded 6 digit counter width - is this enough files?</span>
|
|
390
|
+
<span class="ruby-identifier">pad</span> = <span class="ruby-value str">"0"</span> <span class="ruby-operator">*</span> (<span class="ruby-value">6</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@count</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">length</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">count</span>.<span class="ruby-identifier">to_s</span>
|
|
391
|
+
<span class="ruby-identifier">newbase</span> = <span class="ruby-ivar">@baseFilename</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp re">/(\.\w*)$/</span>, <span class="ruby-identifier">pad</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'\1'</span>)
|
|
392
|
+
<span class="ruby-ivar">@filename</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-ivar">@filename</span>), <span class="ruby-identifier">newbase</span>)
|
|
393
|
+
<span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">"File #{@filename} created"</span>}
|
|
394
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
395
|
+
</div>
|
|
396
|
+
|
|
397
|
+
</div>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
</div>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
<div id="requires-oll-method" class="method-detail ">
|
|
404
|
+
<a name="M000119"></a>
|
|
405
|
+
|
|
406
|
+
<div class="method-heading">
|
|
407
|
+
|
|
408
|
+
<span class="method-name">requiresRoll</span><span
|
|
409
|
+
class="method-args">()</span>
|
|
410
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
411
|
+
|
|
412
|
+
</div>
|
|
413
|
+
|
|
414
|
+
<div class="method-description">
|
|
415
|
+
|
|
416
|
+
<p>
|
|
417
|
+
does the file require a roll?
|
|
418
|
+
</p>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
<div class="method-source-code"
|
|
423
|
+
id="requires-oll-source">
|
|
424
|
+
<pre>
|
|
425
|
+
<span class="ruby-comment cmt"># File log4r/outputter/rollingfileoutputter.rb, line 73</span>
|
|
426
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">requiresRoll</span>
|
|
427
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@maxsize</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@datasize</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@maxsize</span>
|
|
428
|
+
<span class="ruby-ivar">@datasize</span> = <span class="ruby-value">0</span>
|
|
429
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
|
|
430
|
+
<span class="ruby-keyword kw">end</span>
|
|
431
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@maxtime</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@startTime</span>) <span class="ruby-operator">></span> <span class="ruby-ivar">@maxtime</span>
|
|
432
|
+
<span class="ruby-ivar">@startTime</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
|
|
433
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
|
|
434
|
+
<span class="ruby-keyword kw">end</span>
|
|
435
|
+
<span class="ruby-keyword kw">false</span>
|
|
436
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
437
|
+
</div>
|
|
438
|
+
|
|
439
|
+
</div>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
</div>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
<div id="roll-method" class="method-detail ">
|
|
446
|
+
<a name="M000120"></a>
|
|
447
|
+
|
|
448
|
+
<div class="method-heading">
|
|
449
|
+
|
|
450
|
+
<span class="method-name">roll</span><span
|
|
451
|
+
class="method-args">()</span>
|
|
452
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
453
|
+
|
|
454
|
+
</div>
|
|
455
|
+
|
|
456
|
+
<div class="method-description">
|
|
457
|
+
|
|
458
|
+
<p>
|
|
459
|
+
roll the file
|
|
460
|
+
</p>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<div class="method-source-code"
|
|
465
|
+
id="roll-source">
|
|
466
|
+
<pre>
|
|
467
|
+
<span class="ruby-comment cmt"># File log4r/outputter/rollingfileoutputter.rb, line 86</span>
|
|
468
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll</span>
|
|
469
|
+
<span class="ruby-keyword kw">begin</span>
|
|
470
|
+
<span class="ruby-comment cmt"># If @baseFilename == @filename, then this method is about to</span>
|
|
471
|
+
<span class="ruby-comment cmt"># try to close out a file that is not actually opened because</span>
|
|
472
|
+
<span class="ruby-comment cmt"># fileoutputter has been called with the parameter roll=true</span>
|
|
473
|
+
<span class="ruby-keyword kw">if</span> ( <span class="ruby-ivar">@baseFilename</span> <span class="ruby-operator">!=</span> <span class="ruby-ivar">@filename</span> ) <span class="ruby-keyword kw">then</span>
|
|
474
|
+
<span class="ruby-ivar">@out</span>.<span class="ruby-identifier">close</span>
|
|
475
|
+
<span class="ruby-keyword kw">end</span>
|
|
476
|
+
<span class="ruby-keyword kw">rescue</span>
|
|
477
|
+
<span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {
|
|
478
|
+
<span class="ruby-node">"RollingFileOutputter '#{@name}' could not close #{@filename}"</span>
|
|
479
|
+
}
|
|
480
|
+
<span class="ruby-keyword kw">end</span>
|
|
481
|
+
<span class="ruby-ivar">@count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
|
482
|
+
<span class="ruby-identifier">makeNewFilename</span>
|
|
483
|
+
<span class="ruby-ivar">@out</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@filename</span>, (<span class="ruby-ivar">@trunc</span> <span class="ruby-operator">?</span> <span class="ruby-value str">"w"</span> <span class="ruby-operator">:</span> <span class="ruby-value str">"a"</span>))
|
|
484
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
485
|
+
</div>
|
|
486
|
+
|
|
487
|
+
</div>
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
</div>
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
<div id="write-method" class="method-detail ">
|
|
494
|
+
<a name="M000113"></a>
|
|
495
|
+
|
|
496
|
+
<div class="method-heading">
|
|
497
|
+
|
|
498
|
+
<span class="method-name">write</span><span
|
|
499
|
+
class="method-args">(data)</span>
|
|
500
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
501
|
+
|
|
502
|
+
</div>
|
|
503
|
+
|
|
504
|
+
<div class="method-description">
|
|
505
|
+
|
|
506
|
+
<p>
|
|
507
|
+
perform the write
|
|
508
|
+
</p>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
<div class="method-source-code"
|
|
513
|
+
id="write-source">
|
|
514
|
+
<pre>
|
|
515
|
+
<span class="ruby-comment cmt"># File log4r/outputter/rollingfileoutputter.rb, line 55</span>
|
|
516
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write</span>(<span class="ruby-identifier">data</span>)
|
|
517
|
+
<span class="ruby-comment cmt"># we have to keep track of the file size ourselves - File.size doesn't</span>
|
|
518
|
+
<span class="ruby-comment cmt"># seem to report the correct size when the size changes rapidly</span>
|
|
519
|
+
<span class="ruby-ivar">@datasize</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span> <span class="ruby-comment cmt"># the 1 is for newline</span>
|
|
520
|
+
<span class="ruby-keyword kw">super</span>
|
|
521
|
+
<span class="ruby-identifier">roll</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">requiresRoll</span>
|
|
522
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
523
|
+
</div>
|
|
524
|
+
|
|
525
|
+
</div>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
</div>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
</div>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
</div>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
|
538
|
+
|
|
539
|
+
<p>Disabled; run with --debug to generate this.</p>
|
|
540
|
+
|
|
541
|
+
</div>
|
|
542
|
+
|
|
543
|
+
<div id="validator-badges">
|
|
544
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
545
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
546
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
|
547
|
+
</div>
|
|
548
|
+
|
|
549
|
+
</body>
|
|
550
|
+
</html>
|
|
551
|
+
|