← Back to branch summary

~ubuntu-branches/ubuntu/warty/log4cpp-doc/warty

« back to all changes in this revision

Viewing changes to html/class_log4cpp__CategoryStream.html

  • Committer: Bazaar Package Importer
  • Author(s): Marcel Harkema
  • Date: 2001-10-09 13:53:14 UTC
  • Revision ID: james.westby@ubuntu.com-20011009135314-ccobyfh5112p274g
Tags: 0.2.5-2
Fix lintian error (debian-changelog-file-contains-user-emacs-settings).

Show diffs side-by-side

added added

removed removed

Lines of Context:
html/class_log4cpp__CategoryStream.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 
2
<html><head><meta name="robots" content="noindex">
 
3
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
4
<title>log4cpp::CategoryStream class Reference</title>
 
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
6
</head><body bgcolor="#ffffff">
 
7
<!-- Generated by Doxygen 1.2.6 -->
 
8
<center>
 
9
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
 
10
<hr><h1>log4cpp::CategoryStream  Class Reference</h1>This class enables streaming simple types and objects to a category. 
 
11
<a href="#_details">More...</a>
 
12
<p>
 
13
<code>#include &lt;<a class="el" href="Category_hh-source.html">Category.hh</a>&gt;</code>
 
14
<p>
 
15
Collaboration diagram for log4cpp::CategoryStream:<p><center><img src="class_log4cpp__CategoryStream_coll_graph.gif" border="0" usemap="#log4cpp::CategoryStream_coll_map" alt="Collaboration graph"></center>
 
16
<map name="log4cpp::CategoryStream_coll_map">
 
17
<area href="class_log4cpp__OstringStream.html" shape="rect" coords="0,166,141,184">
 
18
<area href="class_std__ostrstream.html" shape="rect" coords="25,83,116,102">
 
19
<area href="class_log4cpp__Category.html" shape="rect" coords="165,166,277,184">
 
20
<area href="class_log4cpp__Appender.html" shape="rect" coords="164,83,279,102">
 
21
<area href="class_log4cpp__Log4cppCleanup.html" shape="rect" coords="144,0,299,19">
 
22
</map>
 
23
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_log4cpp__CategoryStream-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
 
24
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
 
25
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="class_log4cpp__CategoryStream.html#s1">Separator</a> { <a class="el" href="class_log4cpp__CategoryStream.html#s1s0">ENDLINE</a>
 
26
 }</td></tr>
 
27
<tr><td>&nbsp;</td><td><font size=-1><em>Enumeration of special 'Separators'.</em> <a href="#s1">More...</a><em></em></font><br><br></td></tr>
 
28
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
 
29
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_log4cpp__CategoryStream.html#a0">CategoryStream</a> (<a class="el" href="class_log4cpp__Category.html">Category</a> &amp;category, <a class="el" href="class_log4cpp__Priority.html#s0">Priority::Value</a> priority)</td></tr>
 
30
<tr><td>&nbsp;</td><td><font size=-1><em>Construct a <a class="el" href="class_log4cpp__CategoryStream.html">CategoryStream</a> for given <a class="el" href="class_log4cpp__Category.html">Category</a> with given priority.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
 
31
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_log4cpp__CategoryStream.html#a1">~CategoryStream</a> ()</td></tr>
 
32
<tr><td>&nbsp;</td><td><font size=-1><em>Destructor for <a class="el" href="class_log4cpp__CategoryStream.html">CategoryStream</a>.</em></font><br><br></td></tr>
 
33
<tr><td nowrap align=right valign=top><a class="el" href="class_log4cpp__Category.html">Category</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="class_log4cpp__CategoryStream.html#a2">getCategory</a> () const</td></tr>
 
34
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the destination <a class="el" href="class_log4cpp__Category.html">Category</a> for this stream.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
 
35
<tr><td nowrap align=right valign=top><a class="el" href="class_log4cpp__Priority.html#s0">Priority::Value</a>&nbsp;</td><td valign=bottom><a class="el" href="class_log4cpp__CategoryStream.html#a3">getPriority</a> () const  throw ()</td></tr>
 
36
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the priority for this stream.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
 
37
<tr><td nowrap align=right valign=top>CategoryStream&amp;&nbsp;</td><td valign=bottom><a class="el" href="class_log4cpp__CategoryStream.html#a4">operator&lt;&lt;</a> (<a class="el" href="class_log4cpp__CategoryStream.html#s1">Separator</a> separator)</td></tr>
 
38
<tr><td>&nbsp;</td><td><font size=-1><em>Streams in a Separator.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
 
39
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="class_log4cpp__CategoryStream.html#a5">flush</a> ()</td></tr>
 
40
<tr><td>&nbsp;</td><td><font size=-1><em>Flush the contents of the stream buffer to the <a class="el" href="class_log4cpp__Category.html">Category</a> and empties the buffer.</em></font><br><br></td></tr>
 
41
<tr><td nowrap align=right valign=top>CategoryStream&amp;&nbsp;</td><td valign=bottom><a class="el" href="class_log4cpp__CategoryStream.html#a6">operator&lt;&lt;</a> (const T &amp;t)</td></tr>
 
42
<tr><td>&nbsp;</td><td><font size=-1><em>Stream in arbitrary types and objects.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
 
43
</table>
 
44
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
45
This class enables streaming simple types and objects to a category.
 
46
<p>
 
47
Use category.errorStream(), etc. to obtain a <a class="el" href="class_log4cpp__CategoryStream.html">CategoryStream</a> class. 
 
48
<p>
 
49
<hr><h2>Member Enumeration Documentation</h2>
 
50
<a name="s1" doxytag="log4cpp::CategoryStream::Separator"></a><p>
 
51
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
52
  <tr>
 
53
    <td class="md">
 
54
      <table cellpadding="0" cellspacing="0" border="0">
 
55
        <tr>
 
56
          <td nowrap valign="top"><b> 
 
57
enum log4cpp::CategoryStream::Separator
 
58
          </b></td>
 
59
        </tr>
 
60
 
 
61
      </table>
 
62
    </td>
 
63
  </tr>
 
64
</table>
 
65
<table cellspacing=5 cellpadding=0 border=0>
 
66
  <tr>
 
67
    <td>
 
68
      &nbsp;
 
69
    </td>
 
70
    <td>
 
71
 
 
72
<p>
 
73
Enumeration of special 'Separators'.
 
74
<p>
 
75
Currently only contains the 'ENDLINE' separator, which separates two log messages. <dl compact><dt>
 
76
<b>Enumeration values:</b><dd>
 
77
<table border=0 cellspacing=2 cellpadding=0>
 
78
<tr><td valign=top><a name="s1s0" doxytag="ENDLINE"></a><em>ENDLINE</em>
 
79
&nbsp;</td><td>
 
80
</td></tr>
 
81
</table>
 
82
</dl>
 
83
    </td>
 
84
  </tr>
 
85
</table>
 
86
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
87
<a name="a0" doxytag="log4cpp::CategoryStream::CategoryStream"></a><p>
 
88
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
89
  <tr>
 
90
    <td class="md">
 
91
      <table cellpadding="0" cellspacing="0" border="0">
 
92
        <tr>
 
93
          <td nowrap valign="top"><b> 
 
94
log4cpp::CategoryStream::CategoryStream (
 
95
          </b></td>
 
96
          <td valign="bottom"><b>
 
97
<a class="el" href="class_log4cpp__Category.html">Category</a> &amp; <em>category</em>, 
 
98
          </b></td>
 
99
        </tr>
 
100
        <tr>
 
101
          <td></td>
 
102
          <td><b>
 
103
<a class="el" href="class_log4cpp__Priority.html#s0">Priority::Value</a> <em>priority</em>&nbsp;)
 
104
          </b></td>
 
105
        </tr>
 
106
 
 
107
      </table>
 
108
    </td>
 
109
  </tr>
 
110
</table>
 
111
<table cellspacing=5 cellpadding=0 border=0>
 
112
  <tr>
 
113
    <td>
 
114
      &nbsp;
 
115
    </td>
 
116
    <td>
 
117
 
 
118
<p>
 
119
Construct a <a class="el" href="class_log4cpp__CategoryStream.html">CategoryStream</a> for given <a class="el" href="class_log4cpp__Category.html">Category</a> with given priority.
 
120
<p>
 
121
<dl compact><dt>
 
122
<b>Parameters: </b><dd>
 
123
<table border=0 cellspacing=2 cellpadding=0>
 
124
<tr><td valign=top><em>category</em>
 
125
&nbsp;</td><td>
 
126
The category this stream will send log messages to. </td></tr>
 
127
<tr><td valign=top><em>priority</em>
 
128
&nbsp;</td><td>
 
129
The priority the log messages will get or  <a class="el" href="class_log4cpp__Priority.html#s11s10">Priority::NOTSET</a> to silently discard any streamed in messages. </td></tr>
 
130
</table>
 
131
</dl>    </td>
 
132
  </tr>
 
133
</table>
 
134
<a name="a1" doxytag="log4cpp::CategoryStream::~CategoryStream"></a><p>
 
135
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
136
  <tr>
 
137
    <td class="md">
 
138
      <table cellpadding="0" cellspacing="0" border="0">
 
139
        <tr>
 
140
          <td nowrap valign="top"><b> 
 
141
log4cpp::CategoryStream::~CategoryStream (
 
142
          </b></td>
 
143
          <td valign="bottom"><b>
 
144
)
 
145
          </b></td>
 
146
        </tr>
 
147
 
 
148
      </table>
 
149
    </td>
 
150
  </tr>
 
151
</table>
 
152
<table cellspacing=5 cellpadding=0 border=0>
 
153
  <tr>
 
154
    <td>
 
155
      &nbsp;
 
156
    </td>
 
157
    <td>
 
158
 
 
159
<p>
 
160
Destructor for <a class="el" href="class_log4cpp__CategoryStream.html">CategoryStream</a>.
 
161
<p>
 
162
    </td>
 
163
  </tr>
 
164
</table>
 
165
<hr><h2>Member Function Documentation</h2>
 
166
<a name="a5" doxytag="log4cpp::CategoryStream::flush"></a><p>
 
167
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
168
  <tr>
 
169
    <td class="md">
 
170
      <table cellpadding="0" cellspacing="0" border="0">
 
171
        <tr>
 
172
          <td nowrap valign="top"><b> 
 
173
void log4cpp::CategoryStream::flush (
 
174
          </b></td>
 
175
          <td valign="bottom"><b>
 
176
)
 
177
          </b></td>
 
178
        </tr>
 
179
 
 
180
      </table>
 
181
    </td>
 
182
  </tr>
 
183
</table>
 
184
<table cellspacing=5 cellpadding=0 border=0>
 
185
  <tr>
 
186
    <td>
 
187
      &nbsp;
 
188
    </td>
 
189
    <td>
 
190
 
 
191
<p>
 
192
Flush the contents of the stream buffer to the <a class="el" href="class_log4cpp__Category.html">Category</a> and empties the buffer.
 
193
<p>
 
194
    </td>
 
195
  </tr>
 
196
</table>
 
197
<a name="a2" doxytag="log4cpp::CategoryStream::getCategory"></a><p>
 
198
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
199
  <tr>
 
200
    <td class="md">
 
201
      <table cellpadding="0" cellspacing="0" border="0">
 
202
        <tr>
 
203
          <td nowrap valign="top"><b> 
 
204
<a class="el" href="class_log4cpp__Category.html">Category</a> &amp; log4cpp::CategoryStream::getCategory (
 
205
          </b></td>
 
206
          <td valign="bottom"><b>
 
207
) const<code> [inline]</code>
 
208
          </b></td>
 
209
        </tr>
 
210
 
 
211
      </table>
 
212
    </td>
 
213
  </tr>
 
214
</table>
 
215
<table cellspacing=5 cellpadding=0 border=0>
 
216
  <tr>
 
217
    <td>
 
218
      &nbsp;
 
219
    </td>
 
220
    <td>
 
221
 
 
222
<p>
 
223
Returns the destination <a class="el" href="class_log4cpp__Category.html">Category</a> for this stream.
 
224
<p>
 
225
<dl compact><dt>
 
226
<b>Returns: </b><dd>
 
227
The <a class="el" href="class_log4cpp__Category.html">Category</a>. </dl>    </td>
 
228
  </tr>
 
229
</table>
 
230
<a name="a3" doxytag="log4cpp::CategoryStream::getPriority"></a><p>
 
231
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
232
  <tr>
 
233
    <td class="md">
 
234
      <table cellpadding="0" cellspacing="0" border="0">
 
235
        <tr>
 
236
          <td nowrap valign="top"><b> 
 
237
<a class="el" href="class_log4cpp__Priority.html#s0">Priority::Value</a> log4cpp::CategoryStream::getPriority (
 
238
          </b></td>
 
239
          <td valign="bottom"><b>
 
240
) const  throw ()<code> [inline]</code>
 
241
          </b></td>
 
242
        </tr>
 
243
 
 
244
      </table>
 
245
    </td>
 
246
  </tr>
 
247
</table>
 
248
<table cellspacing=5 cellpadding=0 border=0>
 
249
  <tr>
 
250
    <td>
 
251
      &nbsp;
 
252
    </td>
 
253
    <td>
 
254
 
 
255
<p>
 
256
Returns the priority for this stream.
 
257
<p>
 
258
<dl compact><dt>
 
259
<b>Returns: </b><dd>
 
260
The priority. </dl>    </td>
 
261
  </tr>
 
262
</table>
 
263
<a name="a6" doxytag="log4cpp::CategoryStream::operator<<"></a><p>
 
264
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
265
  <tr>
 
266
    <td class="md">
 
267
      <table cellpadding="0" cellspacing="0" border="0">
 
268
        <tr>
 
269
          <td nowrap valign="top"><b> 
 
270
CategoryStream &amp; log4cpp::CategoryStream::operator&lt;&lt; (
 
271
          </b></td>
 
272
          <td valign="bottom"><b>
 
273
const T &amp; <em>t</em>&nbsp;)<code> [inline]</code>
 
274
          </b></td>
 
275
        </tr>
 
276
 
 
277
      </table>
 
278
    </td>
 
279
  </tr>
 
280
</table>
 
281
<table cellspacing=5 cellpadding=0 border=0>
 
282
  <tr>
 
283
    <td>
 
284
      &nbsp;
 
285
    </td>
 
286
    <td>
 
287
 
 
288
<p>
 
289
Stream in arbitrary types and objects.
 
290
<p>
 
291
<dl compact><dt>
 
292
<b>Parameters: </b><dd>
 
293
<table border=0 cellspacing=2 cellpadding=0>
 
294
<tr><td valign=top><em>t</em>
 
295
&nbsp;</td><td>
 
296
The value or object to stream in. </td></tr>
 
297
</table>
 
298
</dl><dl compact><dt>
 
299
<b>Returns: </b><dd>
 
300
A reference to itself. </dl>    </td>
 
301
  </tr>
 
302
</table>
 
303
<a name="a4" doxytag="log4cpp::CategoryStream::operator<<"></a><p>
 
304
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
305
  <tr>
 
306
    <td class="md">
 
307
      <table cellpadding="0" cellspacing="0" border="0">
 
308
        <tr>
 
309
          <td nowrap valign="top"><b> 
 
310
CategoryStream &amp; log4cpp::CategoryStream::operator&lt;&lt; (
 
311
          </b></td>
 
312
          <td valign="bottom"><b>
 
313
<a class="el" href="class_log4cpp__CategoryStream.html#s1">Separator</a> <em>separator</em>&nbsp;)
 
314
          </b></td>
 
315
        </tr>
 
316
 
 
317
      </table>
 
318
    </td>
 
319
  </tr>
 
320
</table>
 
321
<table cellspacing=5 cellpadding=0 border=0>
 
322
  <tr>
 
323
    <td>
 
324
      &nbsp;
 
325
    </td>
 
326
    <td>
 
327
 
 
328
<p>
 
329
Streams in a Separator.
 
330
<p>
 
331
If the separator equals  <a class="el" href="class_log4cpp__CategoryStream.html#s1s0">CategoryStream::ENDLINE</a> it sends the contents of the stream buffer to the <a class="el" href="class_log4cpp__Category.html">Category</a> with set priority and empties the buffer. <dl compact><dt>
 
332
<b>Parameters: </b><dd>
 
333
<table border=0 cellspacing=2 cellpadding=0>
 
334
<tr><td valign=top><em>Separator</em>
 
335
&nbsp;</td><td>
 
336
The Separator </td></tr>
 
337
</table>
 
338
</dl><dl compact><dt>
 
339
<b>Returns: </b><dd>
 
340
A reference to itself. </dl>    </td>
 
341
  </tr>
 
342
</table>
 
343
<hr>The documentation for this class was generated from the following file:<ul>
 
344
<li><a class="el" href="Category_hh-source.html">Category.hh</a></ul>
 
345
<hr><address><small>Generated at Mon Jun 11 01:25:22 2001 for log4cpp by
 
346
<a href="http://www.doxygen.org/index.html">
 
347
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
 
348
width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 
349
 &copy;&nbsp;1997-2001</small></address>
 
350
</body>
 
351
</html>