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
|
<!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::RemoteSyslogListener</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 RemoteSyslogListener</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> Logging<br />
<b>Header:</b> Poco/Net/RemoteSyslogListener.h</p>
<h2>Description</h2>
<div class="description">
<p><a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a> implents listening for syslog messages sent over UDP, according to the syslog Working Group Internet Draft: "The syslog Protocol" <<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>>, and "Transmission of syslog messages over UDP" <<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>>. </p>
<p>In addition, <a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a> also supports the "old" BSD syslog protocol, as described in <a href="http://www.ietf.org/rfc/rfc3164.txt" target="_blank">RFC 3164</a>. </p>
<p>The <a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a> is a subclass of <a href="Poco.SplitterChannel.html" title="class Poco::SplitterChannel">Poco::SplitterChannel</a>. Every received log message is sent to the channels registered with addChannel() or the "channel" property. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.SplitterChannel.html" title="class Poco::SplitterChannel">Poco::SplitterChannel</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>, <a href="Poco.SplitterChannel.html" title="class Poco::SplitterChannel">Poco::SplitterChannel</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.RemoteSyslogListener.html#14864" title="Poco::Net::RemoteSyslogListener::close()">close</a>, <a href="Poco.Net.RemoteSyslogListener.html#14861" title="Poco::Net::RemoteSyslogListener::getProperty()">getProperty</a>, <a href="Poco.Net.RemoteSyslogListener.html#14863" title="Poco::Net::RemoteSyslogListener::open()">open</a>, <a href="Poco.Net.RemoteSyslogListener.html#14865" title="Poco::Net::RemoteSyslogListener::registerChannel()">registerChannel</a>, <a href="Poco.Net.RemoteSyslogListener.html#14858" title="Poco::Net::RemoteSyslogListener::setProperty()">setProperty</a></p>
<p><b>Inherited Functions: </b><a href="Poco.SplitterChannel.html#10173" title="Poco::SplitterChannel::addChannel()">addChannel</a>, <a href="Poco.Channel.html#4145" title="Poco::Channel::close()">close</a>, <a href="Poco.SplitterChannel.html#10183" title="Poco::SplitterChannel::count()">count</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.SplitterChannel.html#10175" title="Poco::SplitterChannel::removeChannel()">removeChannel</a>, <a href="Poco.Channel.html#4148" title="Poco::Channel::setProperty()">setProperty</a></p>
<h2>Constructors</h2>
<h3><a name="14855">RemoteSyslogListener</a></h3>
<p class="decl"><a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a>();</p>
<div class="description">
<p>Creates the <a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a>. </p>
</div>
<h3><a name="14856">RemoteSyslogListener</a></h3>
<p class="decl"><a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a>(<br /> <a href="Poco.html#11352" title="Poco::UInt16">Poco::UInt16</a> port<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a>. </p>
</div>
<h2>Destructor</h2>
<h3><a name="14867">~RemoteSyslogListener</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.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">RemoteSyslogListener</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="14864">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>Stops the listener. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.SplitterChannel.html#10182" title="Poco::SplitterChannel::close()">Poco::SplitterChannel::close()</a></p></div>
<h3><a name="14861">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 /> const std::string & 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="14863">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>Starts the listener. </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="14865">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="14858">setProperty</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setProperty(<br /> const std::string & name,<br /> const std::string & value<br />);</p>
<div class="description">
<p>Sets the property with the given value. </p>
<p>The following properties are supported: </p>
<ul>
<li>port: The UDP port number where to listen for UDP. </li>
</ul>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.SplitterChannel.html#10179" title="Poco::SplitterChannel::setProperty()">Poco::SplitterChannel::setProperty()</a></p></div>
<h2>Variables</h2>
<h3><a name="14866">PROP_PORT</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.RemoteSyslogListener.html#14866" title="Poco::Net::RemoteSyslogListener::PROP_PORT">PROP_PORT</a>;</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>
</div>
</body>
</html>
|