<!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 << 3)</p> <div class="description"> <p>kernel messages </p> </div> <p class="decl"><a name="10506">SYSLOG_USER</a> = (1 << 3)</p> <div class="description"> <p>random user-level messages </p> </div> <p class="decl"><a name="10507">SYSLOG_MAIL</a> = (2 << 3)</p> <div class="description"> <p>mail system </p> </div> <p class="decl"><a name="10508">SYSLOG_DAEMON</a> = (3 << 3)</p> <div class="description"> <p>system daemons </p> </div> <p class="decl"><a name="10509">SYSLOG_AUTH</a> = (4 << 3)</p> <div class="description"> <p>security/authorization messages </p> </div> <p class="decl"><a name="10510">SYSLOG_SYSLOG</a> = (5 << 3)</p> <div class="description"> <p>messages generated internally by syslogd </p> </div> <p class="decl"><a name="10511">SYSLOG_LPR</a> = (6 << 3)</p> <div class="description"> <p>line printer subsystem </p> </div> <p class="decl"><a name="10512">SYSLOG_NEWS</a> = (7 << 3)</p> <div class="description"> <p>network news subsystem </p> </div> <p class="decl"><a name="10513">SYSLOG_UUCP</a> = (8 << 3)</p> <div class="description"> <p>UUCP subsystem </p> </div> <p class="decl"><a name="10514">SYSLOG_CRON</a> = (9 << 3)</p> <div class="description"> <p>clock daemon </p> </div> <p class="decl"><a name="10515">SYSLOG_AUTHPRIV</a> = (10 << 3)</p> <div class="description"> <p>security/authorization messages (private) </p> </div> <p class="decl"><a name="10516">SYSLOG_FTP</a> = (11 << 3)</p> <div class="description"> <p>ftp daemon </p> </div> <p class="decl"><a name="10517">SYSLOG_LOCAL0</a> = (16 << 3)</p> <div class="description"> <p>reserved for local use </p> </div> <p class="decl"><a name="10518">SYSLOG_LOCAL1</a> = (17 << 3)</p> <div class="description"> <p>reserved for local use </p> </div> <p class="decl"><a name="10519">SYSLOG_LOCAL2</a> = (18 << 3)</p> <div class="description"> <p>reserved for local use </p> </div> <p class="decl"><a name="10520">SYSLOG_LOCAL3</a> = (19 << 3)</p> <div class="description"> <p>reserved for local use </p> </div> <p class="decl"><a name="10521">SYSLOG_LOCAL4</a> = (20 << 3)</p> <div class="description"> <p>reserved for local use </p> </div> <p class="decl"><a name="10522">SYSLOG_LOCAL5</a> = (21 << 3)</p> <div class="description"> <p>reserved for local use </p> </div> <p class="decl"><a name="10523">SYSLOG_LOCAL6</a> = (22 << 3)</p> <div class="description"> <p>reserved for local use </p> </div> <p class="decl"><a name="10524">SYSLOG_LOCAL7</a> = (23 << 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 /> const std::string & name,<br /> int options = SYSLOG_CONS,<br /> 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 /> 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="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 /> const <a href="Poco.Message.html" title="class Poco::Message">Message</a> & 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 /> 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>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 /> const <a href="Poco.Message.html" title="class Poco::Message">Message</a> & 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 © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
