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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>log4cpp: log4cpp::StringQueueAppender Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1StringQueueAppender.html">StringQueueAppender</a></div>
<h1>log4cpp::StringQueueAppender Class Reference</h1><!-- doxytag: class="log4cpp::StringQueueAppender" --><!-- doxytag: inherits="log4cpp::LayoutAppender" -->This class puts log messages in an in-memory queue.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="StringQueueAppender_8hh-source.html">StringQueueAppender.hh</a>></code>
<p>
Inheritance diagram for log4cpp::StringQueueAppender:<p><center><img src="classlog4cpp_1_1StringQueueAppender__inherit__graph.gif" border="0" usemap="#log4cpp_1_1StringQueueAppender__inherit__map" alt="Inheritance graph"></center>
<map name="log4cpp_1_1StringQueueAppender__inherit__map">
<area shape="rect" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout." alt="" coords="20,155,183,181"><area shape="rect" href="classlog4cpp_1_1AppenderSkeleton.html" title="AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already..." alt="" coords="16,80,187,107"><area shape="rect" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements." alt="" coords="40,5,163,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for log4cpp::StringQueueAppender:<p><center><img src="classlog4cpp_1_1StringQueueAppender__coll__graph.gif" border="0" usemap="#log4cpp_1_1StringQueueAppender__coll__map" alt="Collaboration graph"></center>
<map name="log4cpp_1_1StringQueueAppender__coll__map">
<area shape="rect" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout." alt="" coords="172,277,335,304"><area shape="rect" href="classlog4cpp_1_1AppenderSkeleton.html" title="AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already..." alt="" coords="45,187,216,213"><area shape="rect" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements." alt="" coords="25,96,148,123"><area shape="rect" href="classlog4cpp_1_1threading_1_1Mutex.html" title="log4cpp::threading::Mutex" alt="" coords="5,5,168,32"><area shape="rect" title="_appenderMapMutex" alt="" coords="83,28,91,36"><area shape="rect" title="_appenderMapMutex" alt="" coords="83,92,91,100"><area shape="rect" href="classlog4cpp_1_1Filter.html" title="Users should extend this class to implement customized logging event filtering." alt="" coords="172,96,271,123"><area shape="rect" title="_filter" alt="" coords="204,119,212,127"><area shape="rect" title="_filter" alt="" coords="140,183,148,191"><area shape="rect" title="_chainedFilter" alt="" coords="241,92,249,100"><area shape="rect" title="_chainedFilter" alt="" coords="241,119,249,127"><area shape="rect" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format." alt="" coords="240,187,349,213"><area shape="rect" title="_layout" alt="" coords="284,209,292,217"><area shape="rect" title="_layout" alt="" coords="256,273,264,281"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cpp_1_1StringQueueAppender-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 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_1StringQueueAppender.html#10d1f4d098dbdb70bbf28cd4343932c1">StringQueueAppender</a> (const std::string &name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1StringQueueAppender.html#a1b2f415c53cc764f5969d973217e0cf">~StringQueueAppender</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1StringQueueAppender.html#e666ab5d75d3a7feb80e281ce6a4844b">reopen</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reopens the output destination of this <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a>, e.g. <a href="#e666ab5d75d3a7feb80e281ce6a4844b"></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_1StringQueueAppender.html#5a00a484e9476692f3e1378e3630c3ab">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release any resources allocated within the appender such as file handles, network connections, etc. <a href="#5a00a484e9476692f3e1378e3630c3ab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1StringQueueAppender.html#df3700a0b35a960218dc8579a553dd67">queueSize</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current size of the message queue. <a href="#df3700a0b35a960218dc8579a553dd67"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::queue< std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1StringQueueAppender.html#89469d8106130c9d9fb7fcb4cf3668e3">getQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the queue to which the Appends adds messages. <a href="#89469d8106130c9d9fb7fcb4cf3668e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const std::queue<<br>
std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1StringQueueAppender.html#dd06e9b8b3519e1cb5c2cd3814d00f26">getQueue</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the queue to which the Appends adds messages. <a href="#dd06e9b8b3519e1cb5c2cd3814d00f26"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1StringQueueAppender.html#35b65c5ec85375175aedcd5efc295093">popMessage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pop the oldest log message from the front of the queue. <a href="#35b65c5ec85375175aedcd5efc295093"></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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1StringQueueAppender.html#26091b72e69ac6257e47aea0d91d7ea9">_append</a> (const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends the <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> to the queue. <a href="#26091b72e69ac6257e47aea0d91d7ea9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::queue< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1StringQueueAppender.html#b0f9292e908d1b748e4c6dc3f1765ca2">_queue</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class puts log messages in an in-memory queue.
<p>
Its primary use is in test cases, but it may be useful elsewhere as well.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.4 </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="10d1f4d098dbdb70bbf28cd4343932c1"></a><!-- doxytag: member="log4cpp::StringQueueAppender::StringQueueAppender" ref="10d1f4d098dbdb70bbf28cd4343932c1" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4cpp::StringQueueAppender::StringQueueAppender </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a1b2f415c53cc764f5969d973217e0cf"></a><!-- doxytag: member="log4cpp::StringQueueAppender::~StringQueueAppender" ref="a1b2f415c53cc764f5969d973217e0cf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4cpp::StringQueueAppender::~StringQueueAppender </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e666ab5d75d3a7feb80e281ce6a4844b"></a><!-- doxytag: member="log4cpp::StringQueueAppender::reopen" ref="e666ab5d75d3a7feb80e281ce6a4844b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool log4cpp::StringQueueAppender::reopen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reopens the output destination of this <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a>, e.g.
<p>
the logfile or TCP socket. <dl class="return" compact><dt><b>Returns:</b></dt><dd>false if an error occured during reopening, true otherwise. </dd></dl>
<p>
Reimplemented from <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#1f61281caac83409db298b681635e029">log4cpp::AppenderSkeleton</a>.
</div>
</div><p>
<a class="anchor" name="5a00a484e9476692f3e1378e3630c3ab"></a><!-- doxytag: member="log4cpp::StringQueueAppender::close" ref="5a00a484e9476692f3e1378e3630c3ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void log4cpp::StringQueueAppender::close </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release any resources allocated within the appender such as file handles, network connections, etc.
<p>
<p>
Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#c62f94c6692fd146fcf37455d3e73439">log4cpp::AppenderSkeleton</a>.
</div>
</div><p>
<a class="anchor" name="df3700a0b35a960218dc8579a553dd67"></a><!-- doxytag: member="log4cpp::StringQueueAppender::queueSize" ref="df3700a0b35a960218dc8579a553dd67" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t log4cpp::StringQueueAppender::queueSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the current size of the message queue.
<p>
Shorthand for <a class="el" href="classlog4cpp_1_1StringQueueAppender.html#89469d8106130c9d9fb7fcb4cf3668e3" title="Return the queue to which the Appends adds messages.">getQueue()</a>.size(). <dl class="return" compact><dt><b>Returns:</b></dt><dd>the queue size </dd></dl>
</div>
</div><p>
<a class="anchor" name="89469d8106130c9d9fb7fcb4cf3668e3"></a><!-- doxytag: member="log4cpp::StringQueueAppender::getQueue" ref="89469d8106130c9d9fb7fcb4cf3668e3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::queue< std::string > & log4cpp::StringQueueAppender::getQueue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the queue to which the Appends adds messages.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the message queue </dd></dl>
</div>
</div><p>
<a class="anchor" name="dd06e9b8b3519e1cb5c2cd3814d00f26"></a><!-- doxytag: member="log4cpp::StringQueueAppender::getQueue" ref="dd06e9b8b3519e1cb5c2cd3814d00f26" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::queue< std::string > & log4cpp::StringQueueAppender::getQueue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the queue to which the Appends adds messages.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the message queue </dd></dl>
</div>
</div><p>
<a class="anchor" name="35b65c5ec85375175aedcd5efc295093"></a><!-- doxytag: member="log4cpp::StringQueueAppender::popMessage" ref="35b65c5ec85375175aedcd5efc295093" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string log4cpp::StringQueueAppender::popMessage </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pop the oldest log message from the front of the queue.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the oldest log message </dd></dl>
</div>
</div><p>
<a class="anchor" name="26091b72e69ac6257e47aea0d91d7ea9"></a><!-- doxytag: member="log4cpp::StringQueueAppender::_append" ref="26091b72e69ac6257e47aea0d91d7ea9" args="(const LoggingEvent &event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void log4cpp::StringQueueAppender::_append </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> & </td>
<td class="paramname"> <em>event</em> </td>
<td> ) </td>
<td width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Appends the <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> to the queue.
<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>event</em> </td><td>the <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> to layout and append to the queue. </td></tr>
</table>
</dl>
<p>
Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#643fb2614192ea09b502a3feb27abe66">log4cpp::AppenderSkeleton</a>.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="b0f9292e908d1b748e4c6dc3f1765ca2"></a><!-- doxytag: member="log4cpp::StringQueueAppender::_queue" ref="b0f9292e908d1b748e4c6dc3f1765ca2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::queue<std::string> <a class="el" href="classlog4cpp_1_1StringQueueAppender.html#b0f9292e908d1b748e4c6dc3f1765ca2">log4cpp::StringQueueAppender::_queue</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="StringQueueAppender_8hh-source.html">StringQueueAppender.hh</a><li><a class="el" href="StringQueueAppender_8cpp.html">StringQueueAppender.cpp</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 3 11:55:06 2007 for log4cpp by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
|
