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
|
<!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>Wt: Wt::WLogger Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</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="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="classWt_1_1WLogger.html">WLogger</a>
</div>
</div>
<div class="contents">
<h1>Wt::WLogger Class Reference</h1><!-- doxytag: class="Wt::WLogger" -->A simple logging class.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WLogger></code>
<p>
<p>
<a href="classWt_1_1WLogger-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"><a class="anchor" name="a2eef50d172fa9766e3500675c814535"></a><!-- doxytag: member="Wt::WLogger::WLogger" ref="a2eef50d172fa9766e3500675c814535" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#a2eef50d172fa9766e3500675c814535">WLogger</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new logger. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb96bbbeede82e03a9489f0fb1c43e38"></a><!-- doxytag: member="Wt::WLogger::~WLogger" ref="cb96bbbeede82e03a9489f0fb1c43e38" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#cb96bbbeede82e03a9489f0fb1c43e38">~WLogger</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#e851860f76c299bca96321b7d867a503">setStream</a> (std::ostream &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the output stream. <a href="#e851860f76c299bca96321b7d867a503"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#6d8a07bc92824fe32a123094e7516544">setFile</a> (const std::string &path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the output file. <a href="#6d8a07bc92824fe32a123094e7516544"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#8287b40a0699797f63de2fe5deaaae9a">addField</a> (const std::string &name, bool isString)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a field. <a href="#8287b40a0699797f63de2fe5deaaae9a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fbbcb96569a0296566d50c0cf1333c2c"></a><!-- doxytag: member="Wt::WLogger::fields" ref="fbbcb96569a0296566d50c0cf1333c2c" args="() const " -->
const std::vector< <a class="el" href="classWt_1_1WLogger_1_1Field.html">Field</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#fbbcb96569a0296566d50c0cf1333c2c">fields</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the field list. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classWt_1_1WLogEntry.html">WLogEntry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#38d62bf3508e191c214c26d1959e9988">entry</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a new log entry. <a href="#38d62bf3508e191c214c26d1959e9988"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="structWt_1_1WLogger_1_1Sep.html">Sep</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#c368dcce6c4605855bce2807aad0d267">sep</a> = <a class="el" href="structWt_1_1WLogger_1_1Sep.html">WLogger::Sep</a>()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Field separator constant. <a href="#c368dcce6c4605855bce2807aad0d267"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="structWt_1_1WLogger_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger.html#96559cbf73a0d3647aeeac6d45bcc6b0">timestamp</a> = <a class="el" href="structWt_1_1WLogger_1_1TimeStamp.html">WLogger::TimeStamp</a>()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Timestamp field constant. <a href="#96559cbf73a0d3647aeeac6d45bcc6b0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLogger_1_1Field.html">Field</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class that holds the configuration for a single field. <a href="classWt_1_1WLogger_1_1Field.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1WLogger_1_1Sep.html">Sep</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class that indicates a field separator. <a href="structWt_1_1WLogger_1_1Sep.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1WLogger_1_1TimeStamp.html">TimeStamp</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class that indicates a time stamp. <a href="structWt_1_1WLogger_1_1TimeStamp.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A simple logging class.
<p>
This class logs events to a stream in a flexible way. It allows to create log files using the commonly used <a href="http://www.w3.org/Daemon/User/Config/Logging.html#common-logfile-format">Common Log Format</a> or <a href="http://httpd.apache.org/docs/1.3/logs.html#combined">Combined Log Format</a>, but provides a general way for logging entries that consists of a fixed number of fields.<p>
It is used by Wt to create the application log (<a class="el" href="classWt_1_1WApplication.html#75067771ba8fcc56e174f2e741ce278f" title="Adds an entry to the application log.">WApplication::log()</a>), and built-in httpd access log.<p>
To use this class for custom logging, you should instantiate a logger, add one or more field definitions using <a class="el" href="classWt_1_1WLogger.html#8287b40a0699797f63de2fe5deaaae9a" title="Add a field.">addField()</a>, and set an output stream using <a class="el" href="classWt_1_1WLogger.html#e851860f76c299bca96321b7d867a503" title="Set the output stream.">setStream()</a> or <a class="el" href="classWt_1_1WLogger.html#6d8a07bc92824fe32a123094e7516544" title="Set the output file.">setFile()</a>. To stream data to the logger, use <a class="el" href="classWt_1_1WLogger.html#38d62bf3508e191c214c26d1959e9988" title="Start a new log entry.">entry()</a> to start formatting a new entry.<p>
Usage example: <div class="fragment"><pre class="fragment"> <span class="comment">// Setup the logger</span>
<a class="code" href="classWt_1_1WLogger.html" title="A simple logging class.">Wt::WLogger</a> logger;
logger.<a class="code" href="classWt_1_1WLogger.html#8287b40a0699797f63de2fe5deaaae9a" title="Add a field.">addField</a>(<span class="stringliteral">"datetime"</span>, <span class="keyword">false</span>);
logger.<a class="code" href="classWt_1_1WLogger.html#8287b40a0699797f63de2fe5deaaae9a" title="Add a field.">addField</a>(<span class="stringliteral">"session"</span>, <span class="keyword">false</span>);
logger.<a class="code" href="classWt_1_1WLogger.html#8287b40a0699797f63de2fe5deaaae9a" title="Add a field.">addField</a>(<span class="stringliteral">"type"</span>, <span class="keyword">false</span>);
logger.<a class="code" href="classWt_1_1WLogger.html#8287b40a0699797f63de2fe5deaaae9a" title="Add a field.">addField</a>(<span class="stringliteral">"message"</span>, <span class="keyword">true</span>);
logger.<a class="code" href="classWt_1_1WLogger.html#6d8a07bc92824fe32a123094e7516544" title="Set the output file.">setFile</a>(<span class="stringliteral">"/tmp/mylog.txt"</span>);
<span class="comment">// Add an entry</span>
<a class="code" href="classWt_1_1WLogEntry.html" title="A stream-like object for creating an entry in a log file.">Wt::WLogEntry</a> <a class="code" href="classWt_1_1WLogger.html#38d62bf3508e191c214c26d1959e9988" title="Start a new log entry.">entry</a> = logger.<a class="code" href="classWt_1_1WLogger.html#38d62bf3508e191c214c26d1959e9988" title="Start a new log entry.">entry</a>();
entry << <a class="code" href="classWt_1_1WLogger.html#96559cbf73a0d3647aeeac6d45bcc6b0" title="Timestamp field constant.">Wt::WLogger::timestamp</a> << <a class="code" href="classWt_1_1WLogger.html#c368dcce6c4605855bce2807aad0d267" title="Field separator constant.">Wt::WLogger::sep</a>
<< <span class="charliteral">'['</span> << wApp->sessionId() << <span class="charliteral">']'</span> << <a class="code" href="classWt_1_1WLogger.html#c368dcce6c4605855bce2807aad0d267" title="Field separator constant.">Wt::WLogger::sep</a>
<< <span class="charliteral">'['</span> << <span class="stringliteral">"notice"</span> << <span class="charliteral">']'</span> << <a class="code" href="classWt_1_1WLogger.html#c368dcce6c4605855bce2807aad0d267" title="Field separator constant.">Wt::WLogger::sep</a>
<< <span class="stringliteral">"Succesfully started."</span>;
</pre></div><p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#75067771ba8fcc56e174f2e741ce278f" title="Adds an entry to the application log.">WApplication::log()</a> </dd></dl>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e851860f76c299bca96321b7d867a503"></a><!-- doxytag: member="Wt::WLogger::setStream" ref="e851860f76c299bca96321b7d867a503" args="(std::ostream &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WLogger::setStream </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the output stream.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WLogger.html#6d8a07bc92824fe32a123094e7516544" title="Set the output file.">setFile()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="6d8a07bc92824fe32a123094e7516544"></a><!-- doxytag: member="Wt::WLogger::setFile" ref="6d8a07bc92824fe32a123094e7516544" args="(const std::string &path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WLogger::setFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>path</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the output file.
<p>
Opens a file output stream for <code>path</code>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WLogger.html#e851860f76c299bca96321b7d867a503" title="Set the output stream.">setStream()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="8287b40a0699797f63de2fe5deaaae9a"></a><!-- doxytag: member="Wt::WLogger::addField" ref="8287b40a0699797f63de2fe5deaaae9a" args="(const std::string &name, bool isString)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WLogger::addField </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>isString</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a field.
<p>
Add a field to the logger. When <code>isString</code> is <code>true</code>, values will be quoted.
</div>
</div><p>
<a class="anchor" name="38d62bf3508e191c214c26d1959e9988"></a><!-- doxytag: member="Wt::WLogger::entry" ref="38d62bf3508e191c214c26d1959e9988" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WLogEntry.html">WLogEntry</a> Wt::WLogger::entry </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start a new log entry.
<p>
Returns a new entry. The entry is logged in the destructor of the entry (i.e. when the entry goes out of scope).
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="c368dcce6c4605855bce2807aad0d267"></a><!-- doxytag: member="Wt::WLogger::sep" ref="c368dcce6c4605855bce2807aad0d267" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structWt_1_1WLogger_1_1Sep.html">WLogger::Sep</a> <a class="el" href="classWt_1_1WLogger.html#c368dcce6c4605855bce2807aad0d267">Wt::WLogger::sep</a> = <a class="el" href="structWt_1_1WLogger_1_1Sep.html">WLogger::Sep</a>()<code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Field separator constant.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WLogEntry.html#f8046b0ecb69a59ae7beb9c45996f2a3" title="Writes a field separator.">WLogEntry::operator<<(const WLogger::Sep&)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="96559cbf73a0d3647aeeac6d45bcc6b0"></a><!-- doxytag: member="Wt::WLogger::timestamp" ref="96559cbf73a0d3647aeeac6d45bcc6b0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structWt_1_1WLogger_1_1TimeStamp.html">WLogger::TimeStamp</a> <a class="el" href="classWt_1_1WLogger.html#96559cbf73a0d3647aeeac6d45bcc6b0">Wt::WLogger::timestamp</a> = <a class="el" href="structWt_1_1WLogger_1_1TimeStamp.html">WLogger::TimeStamp</a>()<code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Timestamp field constant.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WLogEntry.html#ba127b67d182be2f88d292dd65706faf" title="Writes a time stamp in the current field.">WLogEntry::operator<<(const WLogger::TimeStamp&)</a> </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:07 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
</body>
</html>
|
