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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>log4cpp: log4cpp::Filter Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<div class="nav">
<a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1Filter.html">Filter</a></div>
<h1>log4cpp::Filter Class Reference</h1>Users should extend this class to implement customized logging event filtering.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Filter_8hh-source.html">Filter.hh</a>></code>
<p>
Collaboration diagram for log4cpp::Filter:<p><center><img src="classlog4cpp_1_1Filter__coll__graph.png" border="0" usemap="#log4cpp_1_1Filter__coll__map" alt="Collaboration graph"></center>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cpp_1_1Filter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#w3">Decision</a> { <a class="el" href="classlog4cpp_1_1Filter.html#w3w0">DENY</a> = -1,
<a class="el" href="classlog4cpp_1_1Filter.html#w3w1">NEUTRAL</a> = 0,
<a class="el" href="classlog4cpp_1_1Filter.html#w3w2">ACCEPT</a> = 1
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#a0">Filter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor for <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a>. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#a1">~Filter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a>. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#a2">setChainedFilter</a> (<a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> *filter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the next <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> in the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#a3">getChainedFilter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> in the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#a4">getEndOfChain</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> in the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#a5">appendChainedFilter</a> (<a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> *filter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> to the end of the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classlog4cpp_1_1Filter.html#w3">Decision</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#a6">decide</a> (const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decide whether to accept or deny a <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a>. <a href="#a6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classlog4cpp_1_1Filter.html#w3">Decision</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Filter.html#b0">_decide</a> (const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &event)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decide whether <b>this</b> <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> accepts or denies the given <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a>. <a href="#b0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Users should extend this class to implement customized logging event filtering.
<p>
Note that <a class="el" href="classlog4cpp_1_1Category.html">log4cpp::Category</a> and lof4cpp::Appender have built-in filtering rules. It is suggested that you first use and understand the built-in rules before rushing to write your own custom filters.<p>
This abstract class assumes and also imposes that filters be organized in a linear chain. The <code>decide(LoggingEvent)</code> method of each filter is called sequentially, in the order of their addition to the chain.<p>
The <code>decide(LoggingEvent)</code> method must return a Decision value, either DENY, NEUTRAL or ACCCEPT.<p>
If the value DENY is returned, then the log event is dropped immediately without consulting with the remaining filters.<p>
If the value NEUTRAL is returned, then the next filter in the chain is consulted. If there are no more filters in the chain, then the log event is logged. Thus, in the presence of no filters, the default behaviour is to log all logging events.<p>
If the value ACCEPT is returned, then the log event is logged without consulting the remaining filters.<p>
The philosophy of <a class="el" href="namespacelog4cpp.html">log4cpp</a> filters is largely inspired from the Linux ipchains.
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w3" doxytag="log4cpp::Filter::Decision"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">enum <a class="el" href="classlog4cpp_1_1Filter.html#w3">log4cpp::Filter::Decision</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="w3w0" doxytag="DENY"></a>DENY</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w3w1" doxytag="NEUTRAL"></a>NEUTRAL</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w3w2" doxytag="ACCEPT"></a>ACCEPT</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="log4cpp::Filter::Filter"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">log4cpp::Filter::Filter </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Default Constructor for <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="log4cpp::Filter::~Filter"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">log4cpp::Filter::~Filter </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destructor for <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a>.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b0" doxytag="log4cpp::Filter::_decide"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classlog4cpp_1_1Filter.html#w3">Decision</a> log4cpp::Filter::_decide </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>event</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Decide whether <b>this</b> <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> accepts or denies the given <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a>.
<p>
Actual implementation of <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> should override this method and not <code>decide(LoggingEvent&)</code>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> to decide on. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The Decision </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="log4cpp::Filter::appendChainedFilter"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::Filter::appendChainedFilter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>filter</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> to the end of the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain.
<p>
Convience method for <a class="el" href="classlog4cpp_1_1Filter.html#a4">getEndOfChain()</a>->setChainedFilter(filter). <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filter</em> </td><td>The filter to add to the end of the chain. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="log4cpp::Filter::decide"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Filter.html#w3">Filter::Decision</a> log4cpp::Filter::decide </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>event</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Decide whether to accept or deny a <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a>.
<p>
This method will walk the entire chain until a non neutral decision has been made or the end of the chain has been reached. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> to decide on. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The Decision </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="log4cpp::Filter::getChainedFilter"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> * log4cpp::Filter::getChainedFilter </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the next <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> in the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The next <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> or NULL if the current filter is the last in the chain </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="log4cpp::Filter::getEndOfChain"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> * log4cpp::Filter::getEndOfChain </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the last <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> in the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The last <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> in the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="log4cpp::Filter::setChainedFilter"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::Filter::setChainedFilter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>filter</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the next <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> in the <a class="el" href="classlog4cpp_1_1Filter.html">Filter</a> chain.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filter</em> </td><td>The filter to chain </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Filter_8hh-source.html">Filter.hh</a><li><a class="el" href="Filter_8cpp.html">Filter.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jul 29 14:12:17 2005 for log4cpp by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
