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
|
<!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::LoggingEvent Struct 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="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a></div>
<h1>log4cpp::LoggingEvent Struct Reference</h1><!-- doxytag: class="log4cpp::LoggingEvent" -->The internal representation of logging events.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="LoggingEvent_8hh-source.html">LoggingEvent.hh</a>></code>
<p>
Collaboration diagram for log4cpp::LoggingEvent:<p><center><img src="structlog4cpp_1_1LoggingEvent__coll__graph.gif" border="0" usemap="#log4cpp_1_1LoggingEvent__coll__map" alt="Collaboration graph"></center>
<map name="log4cpp_1_1LoggingEvent__coll__map">
<area shape="rect" href="classlog4cpp_1_1TimeStamp.html" title="A simple TimeStamp abstraction." alt="" coords="12,12,145,39"><area shape="rect" title="timeStamp" alt="" coords="75,35,83,43"><area shape="rect" title="timeStamp" alt="" coords="75,99,83,107"><area shape="rect" title="_startStamp" alt="" coords="104,8,112,16"><area shape="rect" title="_startStamp" alt="" coords="104,35,112,43"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="structlog4cpp_1_1LoggingEvent-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="structlog4cpp_1_1LoggingEvent.html#ceb2b44a66f1b46e5ccf7805cbf46088">LoggingEvent</a> (const std::string &category, const std::string &<a class="el" href="structlog4cpp_1_1LoggingEvent.html#0880d85605e03289daf333f25868b814">message</a>, const std::string &<a class="el" href="structlog4cpp_1_1LoggingEvent.html#1d86cfec2108acc064878550b38f9d5f">ndc</a>, <a class="el" href="classlog4cpp_1_1Priority.html#19c2e47a94a531d3028f7c545671ff72">Priority::Value</a> <a class="el" href="structlog4cpp_1_1LoggingEvent.html#d2fb835fe723dbb526b71423b4d16951">priority</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> from the supplied parameters. <a href="#ceb2b44a66f1b46e5ccf7805cbf46088"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#1cca378605dec8f497834b9d64e7fd99">categoryName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The category name. <a href="#1cca378605dec8f497834b9d64e7fd99"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#0880d85605e03289daf333f25868b814">message</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The application supplied message of logging event. <a href="#0880d85605e03289daf333f25868b814"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#1d86cfec2108acc064878550b38f9d5f">ndc</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The nested diagnostic context (<a class="el" href="classlog4cpp_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in...">NDC</a>) of logging event. <a href="#1d86cfec2108acc064878550b38f9d5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1Priority.html#19c2e47a94a531d3028f7c545671ff72">Priority::Value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#d2fb835fe723dbb526b71423b4d16951">priority</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classlog4cpp_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages...">Priority</a> of logging event. <a href="#d2fb835fe723dbb526b71423b4d16951"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#66969a4433669348c0fe1772c0c7e522">threadName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of thread in which this logging event was generated, e.g. <a href="#66969a4433669348c0fe1772c0c7e522"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#e260062ce70e1a684b8a37c8233dd59e">timeStamp</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created. <a href="#e260062ce70e1a684b8a37c8233dd59e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The internal representation of logging events.
<p>
When a affirmative logging decision is made a <code><a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a></code> instance is created. This instance is passed around the different <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> components.<p>
This class is of concern to those wishing to extend <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a>.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ceb2b44a66f1b46e5ccf7805cbf46088"></a><!-- doxytag: member="log4cpp::LoggingEvent::LoggingEvent" ref="ceb2b44a66f1b46e5ccf7805cbf46088" args="(const std::string &category, const std::string &message, const std::string &ndc, Priority::Value priority)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4cpp::LoggingEvent::LoggingEvent </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>ndc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cpp_1_1Priority.html#19c2e47a94a531d3028f7c545671ff72">Priority::Value</a> </td>
<td class="paramname"> <em>priority</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Instantiate a <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> from the supplied parameters.
<p>
Except <code>timeStamp</code> all the other fields of <code><a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a></code> are filled when actually needed. <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>category</em> </td><td>The category of this event. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>The message of this event. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ndc</em> </td><td>The nested diagnostic context of this event. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>The priority of this event. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="1cca378605dec8f497834b9d64e7fd99"></a><!-- doxytag: member="log4cpp::LoggingEvent::categoryName" ref="1cca378605dec8f497834b9d64e7fd99" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string <a class="el" href="structlog4cpp_1_1LoggingEvent.html#1cca378605dec8f497834b9d64e7fd99">log4cpp::LoggingEvent::categoryName</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The category name.
<p>
</div>
</div><p>
<a class="anchor" name="0880d85605e03289daf333f25868b814"></a><!-- doxytag: member="log4cpp::LoggingEvent::message" ref="0880d85605e03289daf333f25868b814" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string <a class="el" href="structlog4cpp_1_1LoggingEvent.html#0880d85605e03289daf333f25868b814">log4cpp::LoggingEvent::message</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The application supplied message of logging event.
<p>
</div>
</div><p>
<a class="anchor" name="1d86cfec2108acc064878550b38f9d5f"></a><!-- doxytag: member="log4cpp::LoggingEvent::ndc" ref="1d86cfec2108acc064878550b38f9d5f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string <a class="el" href="structlog4cpp_1_1LoggingEvent.html#1d86cfec2108acc064878550b38f9d5f">log4cpp::LoggingEvent::ndc</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The nested diagnostic context (<a class="el" href="classlog4cpp_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in...">NDC</a>) of logging event.
<p>
</div>
</div><p>
<a class="anchor" name="d2fb835fe723dbb526b71423b4d16951"></a><!-- doxytag: member="log4cpp::LoggingEvent::priority" ref="d2fb835fe723dbb526b71423b4d16951" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cpp_1_1Priority.html#19c2e47a94a531d3028f7c545671ff72">Priority::Value</a> <a class="el" href="structlog4cpp_1_1LoggingEvent.html#d2fb835fe723dbb526b71423b4d16951">log4cpp::LoggingEvent::priority</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classlog4cpp_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages...">Priority</a> of logging event.
<p>
</div>
</div><p>
<a class="anchor" name="66969a4433669348c0fe1772c0c7e522"></a><!-- doxytag: member="log4cpp::LoggingEvent::threadName" ref="66969a4433669348c0fe1772c0c7e522" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string <a class="el" href="structlog4cpp_1_1LoggingEvent.html#66969a4433669348c0fe1772c0c7e522">log4cpp::LoggingEvent::threadName</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The name of thread in which this logging event was generated, e.g.
<p>
the PID.
</div>
</div><p>
<a class="anchor" name="e260062ce70e1a684b8a37c8233dd59e"></a><!-- doxytag: member="log4cpp::LoggingEvent::timeStamp" ref="e260062ce70e1a684b8a37c8233dd59e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cpp_1_1TimeStamp.html">TimeStamp</a> <a class="el" href="structlog4cpp_1_1LoggingEvent.html#e260062ce70e1a684b8a37c8233dd59e">log4cpp::LoggingEvent::timeStamp</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="LoggingEvent_8hh-source.html">LoggingEvent.hh</a><li><a class="el" href="LoggingEvent_8cpp.html">LoggingEvent.cpp</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 3 11:55:05 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>
|
