File: structlog4cpp_1_1LoggingEvent.html

package info (click to toggle)
log4cpp-doc 0.3.5-rc3-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 5,664 kB
  • ctags: 925
  • sloc: makefile: 34
file content (269 lines) | stat: -rw-r--r-- 12,947 bytes parent folder | download
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
<!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::LoggingEvent Struct 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></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>The internal representation of logging events.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="LoggingEvent_8hh-source.html">LoggingEvent.hh</a>&gt;</code>
<p>
Collaboration diagram for log4cpp::LoggingEvent:<p><center><img src="structlog4cpp_1_1LoggingEvent__coll__graph.png" border="0" usemap="#log4cpp_1_1LoggingEvent__coll__map" alt="Collaboration graph"></center>
<map name="log4cpp_1_1LoggingEvent__coll__map">
<area href="classlog4cpp_1_1TimeStamp.html" shape="rect" coords="14,9,158,33" alt="">
</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#a0">LoggingEvent</a> (const std::string &amp;category, const std::string &amp;<a class="el" href="structlog4cpp_1_1LoggingEvent.html#o1">message</a>, const std::string &amp;<a class="el" href="structlog4cpp_1_1LoggingEvent.html#o2">ndc</a>, <a class="el" href="classlog4cpp_1_1Priority.html#w0">Priority::Value</a> <a class="el" href="structlog4cpp_1_1LoggingEvent.html#o3">priority</a>)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Instantiate a <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> from the supplied parameters.  <a href="#a0"></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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#o0">categoryName</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The category name.  <a href="#o0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#o1">message</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The application supplied message of logging event.  <a href="#o1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#o2">ndc</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The nested diagnostic context (<a class="el" href="classlog4cpp_1_1NDC.html">NDC</a>) of logging event.  <a href="#o2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1Priority.html#w0">Priority::Value</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#o3">priority</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classlog4cpp_1_1Priority.html">Priority</a> of logging event.  <a href="#o3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#o4">threadName</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of thread in which this logging event was generated, e.g.  <a href="#o4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1TimeStamp.html">TimeStamp</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4cpp_1_1LoggingEvent.html#o5">timeStamp</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</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="#o5"></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">LoggingEvent</a></code> instance is created. This instance is passed around the different <a class="el" href="namespacelog4cpp.html">log4cpp</a> components.<p>
This class is of concern to those wishing to extend <a class="el" href="namespacelog4cpp.html">log4cpp</a>. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="log4cpp::LoggingEvent::LoggingEvent"></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::LoggingEvent::LoggingEvent           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>category</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const std::string &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>message</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const std::string &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>ndc</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classlog4cpp_1_1Priority.html#w0">Priority::Value</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>priority</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Instantiate a <a class="el" href="structlog4cpp_1_1LoggingEvent.html">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">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>&nbsp;</td><td>The category of this event. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>The message of this event. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ndc</em>&nbsp;</td><td>The nested diagnostic context of this event. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>priority</em>&nbsp;</td><td>The priority of this event. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o0" doxytag="log4cpp::LoggingEvent::categoryName"></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">const std::string <a class="el" href="structlog4cpp_1_1LoggingEvent.html#o0">log4cpp::LoggingEvent::categoryName</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The category name. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="o1" doxytag="log4cpp::LoggingEvent::message"></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">const std::string <a class="el" href="structlog4cpp_1_1LoggingEvent.html#o1">log4cpp::LoggingEvent::message</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The application supplied message of logging event. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="o2" doxytag="log4cpp::LoggingEvent::ndc"></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">const std::string <a class="el" href="structlog4cpp_1_1LoggingEvent.html#o2">log4cpp::LoggingEvent::ndc</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The nested diagnostic context (<a class="el" href="classlog4cpp_1_1NDC.html">NDC</a>) of logging event. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="o3" doxytag="log4cpp::LoggingEvent::priority"></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_1Priority.html#w0">Priority::Value</a> <a class="el" href="structlog4cpp_1_1LoggingEvent.html#o3">log4cpp::LoggingEvent::priority</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classlog4cpp_1_1Priority.html">Priority</a> of logging event. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="o4" doxytag="log4cpp::LoggingEvent::threadName"></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">const std::string <a class="el" href="structlog4cpp_1_1LoggingEvent.html#o4">log4cpp::LoggingEvent::threadName</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The name of thread in which this logging event was generated, e.g. 
<p>
the PID.     </td>
  </tr>
</table>
<a class="anchor" name="o5" doxytag="log4cpp::LoggingEvent::timeStamp"></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_1TimeStamp.html">TimeStamp</a> <a class="el" href="structlog4cpp_1_1LoggingEvent.html#o5">log4cpp::LoggingEvent::timeStamp</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created. 
<p>
    </td>
  </tr>
</table>
<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="align: right;"><small>Generated on Fri Jul 29 14:12:28 2005 for log4cpp by&nbsp;
<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>