File: Poco.SyslogChannel.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 (219 lines) | stat: -rw-r--r-- 12,403 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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<!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::SyslogChannel</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 SyslogChannel</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Logging<br />
<b>Header:</b> Poco/SyslogChannel.h</p>
<h2>Description</h2>
<div class="description">
<p>This Unix-only channel works with the Unix syslog service. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.Channel.html" title="class Poco::Channel">Channel</a></p>
<p><b>All Base Classes: </b><a href="Poco.Channel.html" title="class Poco::Channel">Channel</a>, <a href="Poco.Configurable.html" title="class Poco::Configurable">Configurable</a>, <a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">RefCountedObject</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.SyslogChannel.html#10531" title="Poco::SyslogChannel::close()">close</a>, <a href="Poco.SyslogChannel.html#10543" title="Poco::SyslogChannel::getPrio()">getPrio</a>, <a href="Poco.SyslogChannel.html#10537" title="Poco::SyslogChannel::getProperty()">getProperty</a>, <a href="Poco.SyslogChannel.html#10532" title="Poco::SyslogChannel::log()">log</a>, <a href="Poco.SyslogChannel.html#10530" title="Poco::SyslogChannel::open()">open</a>, <a href="Poco.SyslogChannel.html#10534" title="Poco::SyslogChannel::setProperty()">setProperty</a></p>
<p><b>Inherited Functions: </b><a href="Poco.Channel.html#4145" title="Poco::Channel::close()">close</a>, <a href="Poco.RefCountedObject.html#9659" title="Poco::RefCountedObject::duplicate()">duplicate</a>, <a href="Poco.Channel.html#4151" title="Poco::Channel::getProperty()">getProperty</a>, <a href="Poco.Channel.html#4146" title="Poco::Channel::log()">log</a>, <a href="Poco.Channel.html#4144" title="Poco::Channel::open()">open</a>, <a href="Poco.RefCountedObject.html#9661" title="Poco::RefCountedObject::referenceCount()">referenceCount</a>, <a href="Poco.RefCountedObject.html#9660" title="Poco::RefCountedObject::release()">release</a>, <a href="Poco.Channel.html#4148" title="Poco::Channel::setProperty()">setProperty</a></p>
<h2>Enumerations</h2>
<h3><a name="10504">Facility</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="10505">SYSLOG_KERN</a> = (0 &lt;&lt; 3)</p>
<div class="description">
<p>kernel messages </p>
</div>
<p class="decl"><a name="10506">SYSLOG_USER</a> = (1 &lt;&lt; 3)</p>
<div class="description">
<p>random user-level messages </p>
</div>
<p class="decl"><a name="10507">SYSLOG_MAIL</a> = (2 &lt;&lt; 3)</p>
<div class="description">
<p>mail system </p>
</div>
<p class="decl"><a name="10508">SYSLOG_DAEMON</a> = (3 &lt;&lt; 3)</p>
<div class="description">
<p>system daemons </p>
</div>
<p class="decl"><a name="10509">SYSLOG_AUTH</a> = (4 &lt;&lt; 3)</p>
<div class="description">
<p>security/authorization messages </p>
</div>
<p class="decl"><a name="10510">SYSLOG_SYSLOG</a> = (5 &lt;&lt; 3)</p>
<div class="description">
<p>messages generated internally by syslogd </p>
</div>
<p class="decl"><a name="10511">SYSLOG_LPR</a> = (6 &lt;&lt; 3)</p>
<div class="description">
<p>line printer subsystem </p>
</div>
<p class="decl"><a name="10512">SYSLOG_NEWS</a> = (7 &lt;&lt; 3)</p>
<div class="description">
<p>network news subsystem </p>
</div>
<p class="decl"><a name="10513">SYSLOG_UUCP</a> = (8 &lt;&lt; 3)</p>
<div class="description">
<p>UUCP subsystem </p>
</div>
<p class="decl"><a name="10514">SYSLOG_CRON</a> = (9 &lt;&lt; 3)</p>
<div class="description">
<p>clock daemon </p>
</div>
<p class="decl"><a name="10515">SYSLOG_AUTHPRIV</a> = (10 &lt;&lt; 3)</p>
<div class="description">
<p>security/authorization messages (private) </p>
</div>
<p class="decl"><a name="10516">SYSLOG_FTP</a> = (11 &lt;&lt; 3)</p>
<div class="description">
<p>ftp daemon </p>
</div>
<p class="decl"><a name="10517">SYSLOG_LOCAL0</a> = (16 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="10518">SYSLOG_LOCAL1</a> = (17 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="10519">SYSLOG_LOCAL2</a> = (18 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="10520">SYSLOG_LOCAL3</a> = (19 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="10521">SYSLOG_LOCAL4</a> = (20 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="10522">SYSLOG_LOCAL5</a> = (21 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="10523">SYSLOG_LOCAL6</a> = (22 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="10524">SYSLOG_LOCAL7</a> = (23 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<h3><a name="10499">Option</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="10500">SYSLOG_PID</a> = 0x01</p>
<div class="description">
<p>log the pid with each message </p>
</div>
<p class="decl"><a name="10501">SYSLOG_CONS</a> = 0x02</p>
<div class="description">
<p>log on the console if errors in sending </p>
</div>
<p class="decl"><a name="10502">SYSLOG_NDELAY</a> = 0x08</p>
<div class="description">
<p>don't delay open </p>
</div>
<p class="decl"><a name="10503">SYSLOG_PERROR</a> = 0x20</p>
<div class="description">
<p>log to stderr as well (not supported on all platforms) </p>
</div>
<h2>Constructors</h2>
<h3><a name="10525">SyslogChannel</a></h3>
<p class="decl"><a href="Poco.SyslogChannel.html" title="class Poco::SyslogChannel">SyslogChannel</a>();</p>
<div class="description">
<p>Creates a <a href="Poco.SyslogChannel.html" title="class Poco::SyslogChannel">SyslogChannel</a>. </p>
</div>
<h3><a name="10526">SyslogChannel</a></h3>
<p class="decl"><a href="Poco.SyslogChannel.html" title="class Poco::SyslogChannel">SyslogChannel</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;int options = SYSLOG_CONS,<br />&nbsp;&nbsp;&nbsp;&nbsp;int facility = SYSLOG_USER<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.SyslogChannel.html" title="class Poco::SyslogChannel">SyslogChannel</a> with the given name, options and facility. </p>
</div>
<h2>Destructor</h2>
<h3><a name="10542">~SyslogChannel</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.SyslogChannel.html" title="class Poco::SyslogChannel">SyslogChannel</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="10531">close</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void close();</p>
<div class="description">
<p>Closes the <a href="Poco.SyslogChannel.html" title="class Poco::SyslogChannel">SyslogChannel</a>. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Channel.html#4145" title="Poco::Channel::close()">Poco::Channel::close()</a></p></div>
<h3><a name="10537">getProperty</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::string getProperty(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name<br />) const;</p>
<div class="description">
<p>Returns the value of the property with the given name. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Channel.html#4151" title="Poco::Channel::getProperty()">Poco::Channel::getProperty()</a></p></div>
<h3><a name="10532">log</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void log(<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>Sens the message's text to the syslog service. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Channel.html#4146" title="Poco::Channel::log()">Poco::Channel::log()</a></p></div>
<h3><a name="10530">open</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void open();</p>
<div class="description">
<p>Opens the <a href="Poco.SyslogChannel.html" title="class Poco::SyslogChannel">SyslogChannel</a>. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Channel.html#4144" title="Poco::Channel::open()">Poco::Channel::open()</a></p></div>
<h3><a name="10534">setProperty</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setProperty(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; value<br />);</p>
<div class="description">
<p>Sets the property with the given value. </p>
<p>The following properties are supported: </p>
<ul>
<li>name:     The name used to identify the source of log messages. </li>
<li>facility: The facility added to each log message. See the <a href="Poco.SyslogChannel.html#10504" title="enum  Poco::SyslogChannel::Facility">Facility</a> enumeration for a list of supported values. </li>
<li>options:  The logging options. See the <a href="Poco.SyslogChannel.html#10499" title="enum  Poco::SyslogChannel::Option">Option</a> enumeration for a list of supported values. </li>
</ul>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Channel.html#4148" title="Poco::Channel::setProperty()">Poco::Channel::setProperty()</a></p></div>
<h3><a name="10543">getPrio</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static int getPrio(<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></p>
</div>
<h2>Variables</h2>
<h3><a name="10540">PROP_FACILITY</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const std::string <a href="Poco.SyslogChannel.html#10540" title="Poco::SyslogChannel::PROP_FACILITY">PROP_FACILITY</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="10539">PROP_NAME</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const std::string <a href="Poco.SyslogChannel.html#10539" title="Poco::SyslogChannel::PROP_NAME">PROP_NAME</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="10541">PROP_OPTIONS</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const std::string <a href="Poco.SyslogChannel.html#10541" title="Poco::SyslogChannel::PROP_OPTIONS">PROP_OPTIONS</a>;</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>