File: Poco.Net.RemoteSyslogChannel.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 (287 lines) | stat: -rw-r--r-- 17,538 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
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
<!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::Net::RemoteSyslogChannel</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.Net.html" class="namespace">Poco::Net</a></h1>
<h1 class="symbol">class RemoteSyslogChannel</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> Logging<br />
<b>Header:</b> Poco/Net/RemoteSyslogChannel.h</p>
<h2>Description</h2>
<div class="description">
<p>This <a href="Poco.Channel.html" title="class Poco::Channel">Channel</a> implements remote syslog logging over UDP according to the syslog Working Group Internet Draft: &quot;The syslog Protocol&quot; &lt;<a href="http://www.ietf.org/internet-drafts/draft-ietf-syslog-protocol-17.txt" target="_blank">http://www.ietf.org/internet-drafts/draft-ietf-syslog-protocol-17.txt</a>&gt;,  and &quot;Transmission of syslog messages over UDP&quot; &lt;<a href="http://www.ietf.org/internet-drafts/draft-ietf-syslog-transport-udp-07.txt" target="_blank">http://www.ietf.org/internet-drafts/draft-ietf-syslog-transport-udp-07.txt</a>&gt;. </p>
<p>In addition, <a href="Poco.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">RemoteSyslogChannel</a> also supports the &quot;old&quot; BSD syslog protocol, as described in <a href="http://www.ietf.org/rfc/rfc3164.txt" target="_blank">RFC 3164</a>. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.Channel.html" title="class Poco::Channel">Poco::Channel</a></p>
<p><b>All Base Classes: </b><a href="Poco.Channel.html" title="class Poco::Channel">Poco::Channel</a>, <a href="Poco.Configurable.html" title="class Poco::Configurable">Poco::Configurable</a>, <a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">Poco::RefCountedObject</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.RemoteSyslogChannel.html#14830" title="Poco::Net::RemoteSyslogChannel::close()">close</a>, <a href="Poco.Net.RemoteSyslogChannel.html#14845" title="Poco::Net::RemoteSyslogChannel::getPrio()">getPrio</a>, <a href="Poco.Net.RemoteSyslogChannel.html#14836" title="Poco::Net::RemoteSyslogChannel::getProperty()">getProperty</a>, <a href="Poco.Net.RemoteSyslogChannel.html#14831" title="Poco::Net::RemoteSyslogChannel::log()">log</a>, <a href="Poco.Net.RemoteSyslogChannel.html#14829" title="Poco::Net::RemoteSyslogChannel::open()">open</a>, <a href="Poco.Net.RemoteSyslogChannel.html#14838" title="Poco::Net::RemoteSyslogChannel::registerChannel()">registerChannel</a>, <a href="Poco.Net.RemoteSyslogChannel.html#14833" title="Poco::Net::RemoteSyslogChannel::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><i>Anonymous</i></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="14822">SYSLOG_PORT</a> = 514</p>
<div class="description">
<p></p>
</div>
<h3><a name="14796">Facility</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="14797">SYSLOG_KERN</a> = (0 &lt;&lt; 3)</p>
<div class="description">
<p>kernel messages </p>
</div>
<p class="decl"><a name="14798">SYSLOG_USER</a> = (1 &lt;&lt; 3)</p>
<div class="description">
<p>random user-level messages </p>
</div>
<p class="decl"><a name="14799">SYSLOG_MAIL</a> = (2 &lt;&lt; 3)</p>
<div class="description">
<p>mail system </p>
</div>
<p class="decl"><a name="14800">SYSLOG_DAEMON</a> = (3 &lt;&lt; 3)</p>
<div class="description">
<p>system daemons </p>
</div>
<p class="decl"><a name="14801">SYSLOG_AUTH</a> = (4 &lt;&lt; 3)</p>
<div class="description">
<p>security/authorization messages </p>
</div>
<p class="decl"><a name="14802">SYSLOG_SYSLOG</a> = (5 &lt;&lt; 3)</p>
<div class="description">
<p>messages generated internally by syslogd </p>
</div>
<p class="decl"><a name="14803">SYSLOG_LPR</a> = (6 &lt;&lt; 3)</p>
<div class="description">
<p>line printer subsystem </p>
</div>
<p class="decl"><a name="14804">SYSLOG_NEWS</a> = (7 &lt;&lt; 3)</p>
<div class="description">
<p>network news subsystem </p>
</div>
<p class="decl"><a name="14805">SYSLOG_UUCP</a> = (8 &lt;&lt; 3)</p>
<div class="description">
<p>UUCP subsystem </p>
</div>
<p class="decl"><a name="14806">SYSLOG_CRON</a> = (9 &lt;&lt; 3)</p>
<div class="description">
<p>clock daemon </p>
</div>
<p class="decl"><a name="14807">SYSLOG_AUTHPRIV</a> = (10 &lt;&lt; 3)</p>
<div class="description">
<p>security/authorization messages (private) </p>
</div>
<p class="decl"><a name="14808">SYSLOG_FTP</a> = (11 &lt;&lt; 3)</p>
<div class="description">
<p>ftp daemon </p>
</div>
<p class="decl"><a name="14809">SYSLOG_NTP</a> = (12 &lt;&lt; 3)</p>
<div class="description">
<p>ntp subsystem </p>
</div>
<p class="decl"><a name="14810">SYSLOG_LOGAUDIT</a> = (13 &lt;&lt; 3)</p>
<div class="description">
<p>log audit </p>
</div>
<p class="decl"><a name="14811">SYSLOG_LOGALERT</a> = (14 &lt;&lt; 3)</p>
<div class="description">
<p>log alert </p>
</div>
<p class="decl"><a name="14812">SYSLOG_CLOCK</a> = (15 &lt;&lt; 3)</p>
<div class="description">
<p>clock deamon </p>
</div>
<p class="decl"><a name="14813">SYSLOG_LOCAL0</a> = (16 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="14814">SYSLOG_LOCAL1</a> = (17 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="14815">SYSLOG_LOCAL2</a> = (18 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="14816">SYSLOG_LOCAL3</a> = (19 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="14817">SYSLOG_LOCAL4</a> = (20 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="14818">SYSLOG_LOCAL5</a> = (21 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="14819">SYSLOG_LOCAL6</a> = (22 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<p class="decl"><a name="14820">SYSLOG_LOCAL7</a> = (23 &lt;&lt; 3)</p>
<div class="description">
<p>reserved for local use </p>
</div>
<h3><a name="14787">Severity</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="14788">SYSLOG_EMERGENCY</a> = 0</p>
<div class="description">
<p>Emergency: system is unusable </p>
</div>
<p class="decl"><a name="14789">SYSLOG_ALERT</a> = 1</p>
<div class="description">
<p>Alert: action must be taken immediately </p>
</div>
<p class="decl"><a name="14790">SYSLOG_CRITICAL</a> = 2</p>
<div class="description">
<p>Critical: critical conditions </p>
</div>
<p class="decl"><a name="14791">SYSLOG_ERROR</a> = 3</p>
<div class="description">
<p>Error: error conditions </p>
</div>
<p class="decl"><a name="14792">SYSLOG_WARNING</a> = 4</p>
<div class="description">
<p>Warning: warning conditions </p>
</div>
<p class="decl"><a name="14793">SYSLOG_NOTICE</a> = 5</p>
<div class="description">
<p>Notice: normal but significant condition </p>
</div>
<p class="decl"><a name="14794">SYSLOG_INFORMATIONAL</a> = 6</p>
<div class="description">
<p>Informational: informational messages </p>
</div>
<p class="decl"><a name="14795">SYSLOG_DEBUG</a> = 7</p>
<div class="description">
<p>Debug: debug-level messages </p>
</div>
<h2>Constructors</h2>
<h3><a name="14823">RemoteSyslogChannel</a></h3>
<p class="decl"><a href="Poco.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">RemoteSyslogChannel</a>();</p>
<div class="description">
<p>Creates a <a href="Poco.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">RemoteSyslogChannel</a>. </p>
</div>
<h3><a name="14824">RemoteSyslogChannel</a></h3>
<p class="decl"><a href="Poco.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">RemoteSyslogChannel</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; address,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;int facility = SYSLOG_USER,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool bsdFormat = false<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">RemoteSyslogChannel</a> with the given target address, name, and facility. If bsdFormat is true, messages are formatted according to <a href="http://www.ietf.org/rfc/rfc3164.txt" target="_blank">RFC 3164</a>. </p>
</div>
<h2>Destructor</h2>
<h3><a name="14844">~RemoteSyslogChannel</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.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">RemoteSyslogChannel</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="14830">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.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">RemoteSyslogChannel</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="14836">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="14831">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>Sends 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="14829">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.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">RemoteSyslogChannel</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="14838">registerChannel</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void registerChannel();</p>
<div class="description">
<p>Registers the channel with the global <a href="Poco.LoggingFactory.html" title="class Poco::LoggingFactory">LoggingFactory</a>. </p>
</div>
<h3><a name="14833">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.Net.RemoteSyslogChannel.html#14796" title="enum  Poco::Net::RemoteSyslogChannel::Facility">Facility</a> enumeration for a list of supported values. The LOG_ prefix can be omitted and values are case insensitive (e.g. a facility value &quot;mail&quot; is recognized as <a href="Poco.Net.RemoteSyslogChannel.html#14799" title="Poco::Net::RemoteSyslogChannel::SYSLOG_MAIL">SYSLOG_MAIL</a>) </li>
<li>format:    &quot;bsd&quot; (<a href="http://www.ietf.org/rfc/rfc3164.txt" target="_blank">RFC 3164</a> format) or &quot;new&quot; (default) </li>
<li>loghost:   The target IP address or host name where log messages are sent. Optionally, a port number (separated by a colon) can also be specified. </li>
<li>host:      (optional) Host name included in syslog messages. If not specified, the host's real domain name or IP address will be used. </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="14845">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="14785">BSD_TIMEFORMAT</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.Net.RemoteSyslogChannel.html#14785" title="Poco::Net::RemoteSyslogChannel::BSD_TIMEFORMAT">BSD_TIMEFORMAT</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="14840">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.Net.RemoteSyslogChannel.html#14840" title="Poco::Net::RemoteSyslogChannel::PROP_FACILITY">PROP_FACILITY</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="14841">PROP_FORMAT</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.Net.RemoteSyslogChannel.html#14841" title="Poco::Net::RemoteSyslogChannel::PROP_FORMAT">PROP_FORMAT</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="14843">PROP_HOST</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.Net.RemoteSyslogChannel.html#14843" title="Poco::Net::RemoteSyslogChannel::PROP_HOST">PROP_HOST</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="14842">PROP_LOGHOST</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.Net.RemoteSyslogChannel.html#14842" title="Poco::Net::RemoteSyslogChannel::PROP_LOGHOST">PROP_LOGHOST</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="14839">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.Net.RemoteSyslogChannel.html#14839" title="Poco::Net::RemoteSyslogChannel::PROP_NAME">PROP_NAME</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="14786">SYSLOG_TIMEFORMAT</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.Net.RemoteSyslogChannel.html#14786" title="Poco::Net::RemoteSyslogChannel::SYSLOG_TIMEFORMAT">SYSLOG_TIMEFORMAT</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>