File: Poco.Message.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (203 lines) | stat: -rw-r--r-- 12,568 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::Message</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class Message</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Logging<br />
<b>Header:</b> Poco/Message.h</p>
<h2>Description</h2>
<div class="description">
<p>This class represents a log message that is sent through a chain of log channels. </p>
<p>A <a href="Poco.Message.html" title="class Poco::Message">Message</a> contains a priority denoting the severity of the message, a source describing its origin, a text describing its meaning, the time of its creation, and an identifier of the process and thread that created the message. </p>
<p>A <a href="Poco.Message.html" title="class Poco::Message">Message</a> can also contain any number of named parameters that contain additional information about the event that caused the message. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Message.html#8468" title="Poco::Message::getPid()">getPid</a>, <a href="Poco.Message.html#8456" title="Poco::Message::getPriority()">getPriority</a>, <a href="Poco.Message.html#8450" title="Poco::Message::getSource()">getSource</a>, <a href="Poco.Message.html#8453" title="Poco::Message::getText()">getText</a>, <a href="Poco.Message.html#8462" title="Poco::Message::getThread()">getThread</a>, <a href="Poco.Message.html#8465" title="Poco::Message::getTid()">getTid</a>, <a href="Poco.Message.html#8459" title="Poco::Message::getTime()">getTime</a>, <a href="Poco.Message.html#8473" title="Poco::Message::init()">init</a>, <a href="Poco.Message.html#8469" title="Poco::Message::operator()">operator</a>, <a href="Poco.Message.html#8444" title="Poco::Message::operator =()">operator&nbsp;=</a>, <a href="Poco.Message.html#8466" title="Poco::Message::setPid()">setPid</a>, <a href="Poco.Message.html#8454" title="Poco::Message::setPriority()">setPriority</a>, <a href="Poco.Message.html#8448" title="Poco::Message::setSource()">setSource</a>, <a href="Poco.Message.html#8451" title="Poco::Message::setText()">setText</a>, <a href="Poco.Message.html#8460" title="Poco::Message::setThread()">setThread</a>, <a href="Poco.Message.html#8463" title="Poco::Message::setTid()">setTid</a>, <a href="Poco.Message.html#8457" title="Poco::Message::setTime()">setTime</a>, <a href="Poco.Message.html#8446" title="Poco::Message::swap()">swap</a></p>
<h2>Types</h2>
<h3><a name="8474">StringMap</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">typedef std::map &lt; std::string, std::string &gt; <a href="Poco.Message.html#8474" title="Poco::Message::StringMap">StringMap</a>;</p>
<div class="description">
<p></p>
</div>
<h2>Enumerations</h2>
<h3><a name="8424">Priority</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="8425">PRIO_FATAL</a> = 1</p>
<div class="description">
<p>A fatal error. The application will most likely terminate. This is the highest priority. </p>
</div>
<p class="decl"><a name="8426">PRIO_CRITICAL</a></p>
<div class="description">
<p>A critical error. The application might not be able to continue running successfully. </p>
</div>
<p class="decl"><a name="8427">PRIO_ERROR</a></p>
<div class="description">
<p>An error. An operation did not complete successfully, but the application as a whole is not affected. </p>
</div>
<p class="decl"><a name="8428">PRIO_WARNING</a></p>
<div class="description">
<p>A warning. An operation completed with an unexpected result. </p>
</div>
<p class="decl"><a name="8429">PRIO_NOTICE</a></p>
<div class="description">
<p>A notice, which is an information with just a higher priority. </p>
</div>
<p class="decl"><a name="8430">PRIO_INFORMATION</a></p>
<div class="description">
<p>An informational message, usually denoting the successful completion of an operation. </p>
</div>
<p class="decl"><a name="8431">PRIO_DEBUG</a></p>
<div class="description">
<p>A debugging message. </p>
</div>
<p class="decl"><a name="8432">PRIO_TRACE</a></p>
<div class="description">
<p>A tracing message. This is the lowest priority. </p>
</div>
<h2>Constructors</h2>
<h3><a name="8433">Message</a></h3>
<p class="decl"><a href="Poco.Message.html" title="class Poco::Message">Message</a>();</p>
<div class="description">
<p>Creates an empty <a href="Poco.Message.html" title="class Poco::Message">Message</a>. The thread and process ids are set. </p>
</div>
<h3><a name="8438">Message</a></h3>
<p class="decl"><a href="Poco.Message.html" title="class Poco::Message">Message</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Message.html" title="class Poco::Message">Message</a> &amp; msg<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.Message.html" title="class Poco::Message">Message</a> by copying another one. </p>
</div>
<h3><a name="8440">Message</a></h3>
<p class="decl"><a href="Poco.Message.html" title="class Poco::Message">Message</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Message.html" title="class Poco::Message">Message</a> &amp; msg,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; text<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.Message.html" title="class Poco::Message">Message</a> by copying all but the text from another message. </p>
</div>
<h3><a name="8434">Message</a></h3>
<p class="decl"><a href="Poco.Message.html" title="class Poco::Message">Message</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; source,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; text,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Message.html#8424" title="enum  Poco::Message::Priority">Priority</a> prio<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.Message.html" title="class Poco::Message">Message</a> with the given source, text and priority. The thread and process ids are set. </p>
</div>
<h2>Destructor</h2>
<h3><a name="8443">~Message</a></h3>
<p class="decl">~<a href="Poco.Message.html" title="class Poco::Message">Message</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Message.html" title="class Poco::Message">Message</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="8468">getPid</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">long getPid() const;</p>
<div class="description">
<p>Returns the process identifier for the message. </p>
</div>
<h3><a name="8456">getPriority</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Message.html#8424" title="enum  Poco::Message::Priority">Priority</a> getPriority() const;</p>
<div class="description">
<p>Returns the priority of the message. </p>
</div>
<h3><a name="8450">getSource</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getSource() const;</p>
<div class="description">
<p>Returns the source of the message. </p>
</div>
<h3><a name="8453">getText</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getText() const;</p>
<div class="description">
<p>Returns the text of the message. </p>
</div>
<h3><a name="8462">getThread</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getThread() const;</p>
<div class="description">
<p>Returns the thread identifier for the message. </p>
</div>
<h3><a name="8465">getTid</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">long getTid() const;</p>
<div class="description">
<p>Returns the numeric thread identifier for the message. </p>
</div>
<h3><a name="8459">getTime</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.Timestamp.html" title="class Poco::Timestamp">Timestamp</a> &amp; getTime() const;</p>
<div class="description">
<p>Returns the time of the message. </p>
</div>
<h3><a name="8469">operator</a></h3>
<p class="decl">const std::string &amp; operator[] (<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; param<br />) const;</p>
<div class="description">
<p>Returns a const reference to the value of the parameter with the given name. Throws a <a href="Poco.NotFoundException.html" title="class Poco::NotFoundException">NotFoundException</a> if the parameter does not exist. </p>
</div>
<h3><a name="8471">operator</a></h3>
<p class="decl">std::string &amp; operator[] (<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; param<br />);</p>
<div class="description">
<p>Returns a reference to the value of the parameter with the given name. This can be used to set the parameter's value. If the parameter does not exist, it is created with an empty string value. </p>
</div>
<h3><a name="8444">operator =</a></h3>
<p class="decl"><a href="Poco.Message.html" title="class Poco::Message">Message</a> &amp; operator = (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Message.html" title="class Poco::Message">Message</a> &amp; msg<br />);</p>
<div class="description">
<p>Assignment operator. </p>
</div>
<h3><a name="8466">setPid</a></h3>
<p class="decl">void setPid(<br />&nbsp;&nbsp;&nbsp;&nbsp;long pid<br />);</p>
<div class="description">
<p>Sets the process identifier for the message. </p>
</div>
<h3><a name="8454">setPriority</a></h3>
<p class="decl">void setPriority(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Message.html#8424" title="enum  Poco::Message::Priority">Priority</a> prio<br />);</p>
<div class="description">
<p>Sets the priority of the message. </p>
</div>
<h3><a name="8448">setSource</a></h3>
<p class="decl">void setSource(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; src<br />);</p>
<div class="description">
<p>Sets the source of the message. </p>
</div>
<h3><a name="8451">setText</a></h3>
<p class="decl">void setText(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; text<br />);</p>
<div class="description">
<p>Sets the text of the message. </p>
</div>
<h3><a name="8460">setThread</a></h3>
<p class="decl">void setThread(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; thread<br />);</p>
<div class="description">
<p>Sets the thread identifier for the message. </p>
</div>
<h3><a name="8463">setTid</a></h3>
<p class="decl">void setTid(<br />&nbsp;&nbsp;&nbsp;&nbsp;long pid<br />);</p>
<div class="description">
<p>Sets the numeric thread identifier for the message. </p>
</div>
<h3><a name="8457">setTime</a></h3>
<p class="decl">void setTime(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Timestamp.html" title="class Poco::Timestamp">Timestamp</a> &amp; time<br />);</p>
<div class="description">
<p>Sets the time of the message. </p>
</div>
<h3><a name="8446">swap</a></h3>
<p class="decl">void swap(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Message.html" title="class Poco::Message">Message</a> &amp; msg<br />);</p>
<div class="description">
<p>Swaps the message with another one.	 </p>
</div>
<h3><a name="8473">init</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void init();</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>