<!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::RemoteSyslogAppender 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_1RemoteSyslogAppender.html">RemoteSyslogAppender</a> </div> </div> <div class="contents"> <h1>log4cpp::RemoteSyslogAppender Class Reference</h1><!-- doxytag: class="log4cpp::RemoteSyslogAppender" --><!-- doxytag: inherits="log4cpp::LayoutAppender" --><a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html" title="RemoteSyslogAppender sends LoggingEvents to a remote syslog system.">RemoteSyslogAppender</a> sends LoggingEvents to a remote syslog system. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="RemoteSyslogAppender_8hh_source.html">RemoteSyslogAppender.hh</a>></code> <p> <div class="dynheader"> Inheritance diagram for log4cpp::RemoteSyslogAppender:</div> <div class="dynsection"> <p><center><img src="classlog4cpp_1_1RemoteSyslogAppender.png" usemap="#log4cpp::RemoteSyslogAppender_map" border="0" alt=""></center> <map name="log4cpp::RemoteSyslogAppender_map"> <area href="classlog4cpp_1_1LayoutAppender.html" alt="log4cpp::LayoutAppender" shape="rect" coords="0,112,198,136"> <area href="classlog4cpp_1_1AppenderSkeleton.html" alt="log4cpp::AppenderSkeleton" shape="rect" coords="0,56,198,80"> <area href="classlog4cpp_1_1Appender.html" alt="log4cpp::Appender" shape="rect" coords="0,0,198,24"> </map> </div> <p> <a href="classlog4cpp_1_1RemoteSyslogAppender-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_1RemoteSyslogAppender.html#d25aa5bcf81d8b25a44d2c34214c53cf">RemoteSyslogAppender</a> (const std::string &name, const std::string &syslogName, const std::string &relayer, int facility=LOG_USER, int portNumber=514)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html" title="RemoteSyslogAppender sends LoggingEvents to a remote syslog system.">RemoteSyslogAppender</a> with given name and name and facility for syslog. <a href="#d25aa5bcf81d8b25a44d2c34214c53cf"></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_1RemoteSyslogAppender.html#7304fffdd22af3da0b3944039633aada">~RemoteSyslogAppender</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_1RemoteSyslogAppender.html#499b6b3a7052860d8ac582492d8f51d7">reopen</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Closes and reopens the socket. <a href="#499b6b3a7052860d8ac582492d8f51d7"></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_1RemoteSyslogAppender.html#61b6d2ff5c3b99714e57ce3569ff0e52">close</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the socket. <a href="#61b6d2ff5c3b99714e57ce3569ff0e52"></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_1RemoteSyslogAppender.html#8d5a4c927b8c4272c23053a86128be41">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="#8d5a4c927b8c4272c23053a86128be41"></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_1RemoteSyslogAppender.html#275fb916dcf93b5e370148015a608bc4">open</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Just creates the socket. <a href="#275fb916dcf93b5e370148015a608bc4"></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_1RemoteSyslogAppender.html#d21e7aac387f546251bbe24ae6a1ba03">_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 the remote syslog. <a href="#d21e7aac387f546251bbe24ae6a1ba03"></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_1RemoteSyslogAppender.html#068f1d86215d5851f870d7cb959f9ad7">_syslogName</a></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_1RemoteSyslogAppender.html#d6e9190e55e194f34e8feb8f5138b70b">_relayer</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_1RemoteSyslogAppender.html#85433696c5adf56eb1f23b2f33b9739a">_facility</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_1RemoteSyslogAppender.html#97f7b25145f9491945062c09d900336f">_portNumber</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">SOCKET </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html#d679950b5a45b366cea826c4307cedc9">_socket</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">in_addr_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html#6900c6dd036f74cf535223448bf83d29">_ipAddr</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html" title="RemoteSyslogAppender sends LoggingEvents to a remote syslog system.">RemoteSyslogAppender</a> sends LoggingEvents to a remote syslog system. <p> Also see: draft-ietf-syslog-syslog-12.txt <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="d25aa5bcf81d8b25a44d2c34214c53cf"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::RemoteSyslogAppender" ref="d25aa5bcf81d8b25a44d2c34214c53cf" args="(const std::string &name, const std::string &syslogName, const std::string &relayer, int facility=LOG_USER, int portNumber=514)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">log4cpp::RemoteSyslogAppender::RemoteSyslogAppender </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">const std::string & </td> <td class="paramname"> <em>relayer</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> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>portNumber</em> = <code>514</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_1RemoteSyslogAppender.html" title="RemoteSyslogAppender sends LoggingEvents to a remote syslog system.">RemoteSyslogAppender</a> with given name and name and facility for 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>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>relayer</em> </td><td>The IP address or hostname of a standard syslog host. </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. Value '-1' implies to use the default. </td></tr> <tr><td valign="top"></td><td valign="top"><em>portNumber</em> </td><td>An alternative port number. Defaults to the standard syslog port number (514). Value '-1' implies to use the default. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="7304fffdd22af3da0b3944039633aada"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::~RemoteSyslogAppender" ref="7304fffdd22af3da0b3944039633aada" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">log4cpp::RemoteSyslogAppender::~RemoteSyslogAppender </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="d21e7aac387f546251bbe24ae6a1ba03"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::_append" ref="d21e7aac387f546251bbe24ae6a1ba03" args="(const LoggingEvent &event)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::RemoteSyslogAppender::_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 the remote 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="61b6d2ff5c3b99714e57ce3569ff0e52"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::close" ref="61b6d2ff5c3b99714e57ce3569ff0e52" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::RemoteSyslogAppender::close </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Closes the socket. <p> <p>Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#c62f94c6692fd146fcf37455d3e73439">log4cpp::AppenderSkeleton</a>.</p> </div> </div><p> <a class="anchor" name="275fb916dcf93b5e370148015a608bc4"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::open" ref="275fb916dcf93b5e370148015a608bc4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::RemoteSyslogAppender::open </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Just creates the socket. <p> </div> </div><p> <a class="anchor" name="499b6b3a7052860d8ac582492d8f51d7"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::reopen" ref="499b6b3a7052860d8ac582492d8f51d7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool log4cpp::RemoteSyslogAppender::reopen </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Closes and reopens the socket. <p> <p>Reimplemented from <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#1f61281caac83409db298b681635e029">log4cpp::AppenderSkeleton</a>.</p> </div> </div><p> <a class="anchor" name="8d5a4c927b8c4272c23053a86128be41"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::toSyslogPriority" ref="8d5a4c927b8c4272c23053a86128be41" args="(Priority::Value priority)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int log4cpp::RemoteSyslogAppender::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="85433696c5adf56eb1f23b2f33b9739a"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::_facility" ref="85433696c5adf56eb1f23b2f33b9739a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html#85433696c5adf56eb1f23b2f33b9739a">log4cpp::RemoteSyslogAppender::_facility</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="6900c6dd036f74cf535223448bf83d29"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::_ipAddr" ref="6900c6dd036f74cf535223448bf83d29" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">in_addr_t <a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html#6900c6dd036f74cf535223448bf83d29">log4cpp::RemoteSyslogAppender::_ipAddr</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="97f7b25145f9491945062c09d900336f"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::_portNumber" ref="97f7b25145f9491945062c09d900336f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html#97f7b25145f9491945062c09d900336f">log4cpp::RemoteSyslogAppender::_portNumber</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="d6e9190e55e194f34e8feb8f5138b70b"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::_relayer" ref="d6e9190e55e194f34e8feb8f5138b70b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::string <a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html#d6e9190e55e194f34e8feb8f5138b70b">log4cpp::RemoteSyslogAppender::_relayer</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="d679950b5a45b366cea826c4307cedc9"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::_socket" ref="d679950b5a45b366cea826c4307cedc9" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SOCKET <a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html#d679950b5a45b366cea826c4307cedc9">log4cpp::RemoteSyslogAppender::_socket</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="068f1d86215d5851f870d7cb959f9ad7"></a><!-- doxytag: member="log4cpp::RemoteSyslogAppender::_syslogName" ref="068f1d86215d5851f870d7cb959f9ad7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::string <a class="el" href="classlog4cpp_1_1RemoteSyslogAppender.html#068f1d86215d5851f870d7cb959f9ad7">log4cpp::RemoteSyslogAppender::_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 files:<ul> <li><a class="el" href="RemoteSyslogAppender_8hh_source.html">RemoteSyslogAppender.hh</a><li><a class="el" href="RemoteSyslogAppender_8cpp.html">RemoteSyslogAppender.cpp</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>