<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>log4cpp: log4cpp::SyslogAppender Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1SyslogAppender.html">SyslogAppender</a> </div> </div> <div class="contents"> <h1>log4cpp::SyslogAppender Class Reference</h1><!-- doxytag: class="log4cpp::SyslogAppender" --><!-- doxytag: inherits="log4cpp::LayoutAppender" --><a class="el" href="classlog4cpp_1_1SyslogAppender.html" title="SyslogAppender sends LoggingEvents to the local syslog system.">SyslogAppender</a> sends LoggingEvents to the local syslog system. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="SyslogAppender_8hh_source.html">SyslogAppender.hh</a>></code> <p> <div class="dynheader"> Inheritance diagram for log4cpp::SyslogAppender:</div> <div class="dynsection"> <p><center><img src="classlog4cpp_1_1SyslogAppender.png" usemap="#log4cpp::SyslogAppender_map" border="0" alt=""></center> <map name="log4cpp::SyslogAppender_map"> <area href="classlog4cpp_1_1LayoutAppender.html" alt="log4cpp::LayoutAppender" shape="rect" coords="0,112,167,136"> <area href="classlog4cpp_1_1AppenderSkeleton.html" alt="log4cpp::AppenderSkeleton" shape="rect" coords="0,56,167,80"> <area href="classlog4cpp_1_1Appender.html" alt="log4cpp::Appender" shape="rect" coords="0,0,167,24"> </map> </div> <p> <a href="classlog4cpp_1_1SyslogAppender-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#3dedc5cdf1dc8321649b0e58dd1d07b7">SyslogAppender</a> (const std::string &name, const std::string &syslogName, int facility=LOG_USER)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <a class="el" href="classlog4cpp_1_1SyslogAppender.html" title="SyslogAppender sends LoggingEvents to the local syslog system.">SyslogAppender</a> with given name and name and facility for syslog. <a href="#3dedc5cdf1dc8321649b0e58dd1d07b7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#f1aef1edf10596dc2ab3e9cb14a2e6cb">~SyslogAppender</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#85b701a0503050eabd5cca763bbf0b0c">reopen</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Calls closelog(3) and openlog(3). <a href="#85b701a0503050eabd5cca763bbf0b0c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#add9fc06a928ae8f25a935217dda3aac">close</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Calls closelog(3) to close the syslog file descriptor. <a href="#add9fc06a928ae8f25a935217dda3aac"></a><br></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#8e3264b37ebf7063cfba12b20418595d">toSyslogPriority</a> (<a class="el" href="classlog4cpp_1_1Priority.html#19c2e47a94a531d3028f7c545671ff72">Priority::Value</a> priority)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Translates a <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> priority to a syslog priority. <a href="#8e3264b37ebf7063cfba12b20418595d"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#f88b6d06d8b864da3ddd41a15a99e8ba">open</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Calls openlog(3). <a href="#f88b6d06d8b864da3ddd41a15a99e8ba"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#5a6d3f83e85c83f3105ad7829fe1d3c0">_append</a> (const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &event)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> to syslog. <a href="#5a6d3f83e85c83f3105ad7829fe1d3c0"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#cbff484f670bcd3be1fb3275ba164be1">_syslogName</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SyslogAppender.html#161acb9eb6afc9bcb939bab4d1e5f405">_facility</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classlog4cpp_1_1SyslogAppender.html" title="SyslogAppender sends LoggingEvents to the local syslog system.">SyslogAppender</a> sends LoggingEvents to the local syslog system. <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="3dedc5cdf1dc8321649b0e58dd1d07b7"></a><!-- doxytag: member="log4cpp::SyslogAppender::SyslogAppender" ref="3dedc5cdf1dc8321649b0e58dd1d07b7" args="(const std::string &name, const std::string &syslogName, int facility=LOG_USER)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">log4cpp::SyslogAppender::SyslogAppender </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>syslogName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>facility</em> = <code>LOG_USER</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Instantiate a <a class="el" href="classlog4cpp_1_1SyslogAppender.html" title="SyslogAppender sends LoggingEvents to the local syslog system.">SyslogAppender</a> with given name and name and facility for syslog. <p> Note that the C syslog API is process global, so instantion of a second <a class="el" href="classlog4cpp_1_1SyslogAppender.html" title="SyslogAppender sends LoggingEvents to the local syslog system.">SyslogAppender</a> will 'overwrite' the syslog name of the first. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a> </td></tr> <tr><td valign="top"></td><td valign="top"><em>syslogName</em> </td><td>The ident parameter in the openlog(3) call. </td></tr> <tr><td valign="top"></td><td valign="top"><em>facility</em> </td><td>The syslog facility to log to. Defaults to LOG_USER. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="f1aef1edf10596dc2ab3e9cb14a2e6cb"></a><!-- doxytag: member="log4cpp::SyslogAppender::~SyslogAppender" ref="f1aef1edf10596dc2ab3e9cb14a2e6cb" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual log4cpp::SyslogAppender::~SyslogAppender </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="5a6d3f83e85c83f3105ad7829fe1d3c0"></a><!-- doxytag: member="log4cpp::SyslogAppender::_append" ref="5a6d3f83e85c83f3105ad7829fe1d3c0" args="(const LoggingEvent &event)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void log4cpp::SyslogAppender::_append </td> <td>(</td> <td class="paramtype">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> & </td> <td class="paramname"> <em>event</em> </td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Sends a <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> to syslog. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>the <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> to log. </td></tr> </table> </dl> <p>Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#643fb2614192ea09b502a3feb27abe66">log4cpp::AppenderSkeleton</a>.</p> </div> </div><p> <a class="anchor" name="add9fc06a928ae8f25a935217dda3aac"></a><!-- doxytag: member="log4cpp::SyslogAppender::close" ref="add9fc06a928ae8f25a935217dda3aac" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void log4cpp::SyslogAppender::close </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Calls closelog(3) to close the syslog file descriptor. <p> <p>Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#c62f94c6692fd146fcf37455d3e73439">log4cpp::AppenderSkeleton</a>.</p> </div> </div><p> <a class="anchor" name="f88b6d06d8b864da3ddd41a15a99e8ba"></a><!-- doxytag: member="log4cpp::SyslogAppender::open" ref="f88b6d06d8b864da3ddd41a15a99e8ba" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void log4cpp::SyslogAppender::open </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Calls openlog(3). <p> </div> </div><p> <a class="anchor" name="85b701a0503050eabd5cca763bbf0b0c"></a><!-- doxytag: member="log4cpp::SyslogAppender::reopen" ref="85b701a0503050eabd5cca763bbf0b0c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool log4cpp::SyslogAppender::reopen </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Calls closelog(3) and openlog(3). <p> <p>Reimplemented from <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#1f61281caac83409db298b681635e029">log4cpp::AppenderSkeleton</a>.</p> </div> </div><p> <a class="anchor" name="8e3264b37ebf7063cfba12b20418595d"></a><!-- doxytag: member="log4cpp::SyslogAppender::toSyslogPriority" ref="8e3264b37ebf7063cfba12b20418595d" args="(Priority::Value priority)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int log4cpp::SyslogAppender::toSyslogPriority </td> <td>(</td> <td class="paramtype"><a class="el" href="classlog4cpp_1_1Priority.html#19c2e47a94a531d3028f7c545671ff72">Priority::Value</a> </td> <td class="paramname"> <em>priority</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Translates a <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> priority to a syslog priority. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>The <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> priority. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the syslog priority. </dd></dl> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="161acb9eb6afc9bcb939bab4d1e5f405"></a><!-- doxytag: member="log4cpp::SyslogAppender::_facility" ref="161acb9eb6afc9bcb939bab4d1e5f405" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classlog4cpp_1_1SyslogAppender.html#161acb9eb6afc9bcb939bab4d1e5f405">log4cpp::SyslogAppender::_facility</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="cbff484f670bcd3be1fb3275ba164be1"></a><!-- doxytag: member="log4cpp::SyslogAppender::_syslogName" ref="cbff484f670bcd3be1fb3275ba164be1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::string <a class="el" href="classlog4cpp_1_1SyslogAppender.html#cbff484f670bcd3be1fb3275ba164be1">log4cpp::SyslogAppender::_syslogName</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="SyslogAppender_8hh_source.html">SyslogAppender.hh</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 19:34:50 2009 for log4cpp by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> </body> </html>