<!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>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: SyslogAppender Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1net_1_1_syslog_appender.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>SyslogAppender Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::net::SyslogAppender" --><!-- doxytag: inherits="log4cxx::AppenderSkeleton" -->
<p>Use <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html" title="Use SyslogAppender to send log messages to a remote syslog daemon.">SyslogAppender</a> to send log messages to a remote syslog daemon.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1_appender_skeleton.html">log4cxx::AppenderSkeleton</a>.</p>
<p><a href="classlog4cxx_1_1net_1_1_syslog_appender-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#ae47c980aa543b85d2fb6500b5e7482b5">SyslogAppender</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a7e702347ed221f452b5a843e34a9c39e">SyslogAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> &<a class="el" href="classlog4cxx_1_1_appender_skeleton.html#af1f4e6a2229d95a18324c4e7fa71be65">layout</a>, int <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a9fff72c89a4bc7a02b6abe8ec1780e11">syslogFacility</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a8ed5850c43c1d0eacf57149b26ecf9cd">SyslogAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> &<a class="el" href="classlog4cxx_1_1_appender_skeleton.html#af1f4e6a2229d95a18324c4e7fa71be65">layout</a>, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &<a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a7c9850c48f6a28ef127d3c1525168f2b">syslogHost</a>, int <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a9fff72c89a4bc7a02b6abe8ec1780e11">syslogFacility</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a73ca108f80997a2278ca8a6a3196b22e">~SyslogAppender</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release any resources held by this <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html" title="Use SyslogAppender to send log messages to a remote syslog daemon.">SyslogAppender</a>. <a href="#a5ae591df94fc66ccb85cbb6565368bca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a77865c6199c0128510162f6a598f2f41">append</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &event, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subclasses of <code><a class="el" href="classlog4cxx_1_1_appender_skeleton.html" title="Implementation base class for all appenders.">AppenderSkeleton</a></code> should implement this method to perform actual logging. <a href="#a77865c6199c0128510162f6a598f2f41"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#aa3df68f8aae152299471992071e202f5">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns immediately as options are activated when they are set. <a href="#aa3df68f8aae152299471992071e202f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#ac1d269357907e0809687a2bec962e1c8">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#ac1d269357907e0809687a2bec962e1c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a4312e727a9ea814779d2c9950dc3c73e">requiresLayout</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html" title="Use SyslogAppender to send log messages to a remote syslog daemon.">SyslogAppender</a> requires a layout. <a href="#a4312e727a9ea814779d2c9950dc3c73e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a72536ece7b9003657beca1ff895365ce">setSyslogHost</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &<a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a7c9850c48f6a28ef127d3c1525168f2b">syslogHost</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>SyslogHost</b> option is the name of the the syslog host where log output should go. <a href="#a72536ece7b9003657beca1ff895365ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a9d8d6e4e39bbc97815537ca470ed02e0">getSyslogHost</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the <b>SyslogHost</b> option. <a href="#a9d8d6e4e39bbc97815537ca470ed02e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a8ef6f5fc7bac499368350543740bd38f">setFacility</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &facilityName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the syslog facility. <a href="#a8ef6f5fc7bac499368350543740bd38f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#ae73e5e3083de8146ce4c662eb5d89c56">getFacility</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the <b>Facility</b> option. <a href="#ae73e5e3083de8146ce4c662eb5d89c56"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#aa1452821e8afb10aaa35440a0f13befa">setFacilityPrinting</a> (bool facilityPrinting1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the <b>FacilityPrinting</b> option is set to true, the printed message will include the facility name of the application. <a href="#aa1452821e8afb10aaa35440a0f13befa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#aea55c55a58b3127e4c628c39bc15329c">getFacilityPrinting</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the <b>FacilityPrinting</b> option. <a href="#aea55c55a58b3127e4c628c39bc15329c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#aaf365cb50db7ff7ca2fd5d784dc07e74">getFacilityString</a> (int <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a9fff72c89a4bc7a02b6abe8ec1780e11">syslogFacility</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the specified syslog facility as a lower-case String, e.g. <a href="#aaf365cb50db7ff7ca2fd5d784dc07e74"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a7d398008aef6746228f16915ee9ee8a8">getFacility</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &facilityName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the integer value corresponding to the named syslog facility, or -1 if it couldn't be recognized. <a href="#a7d398008aef6746228f16915ee9ee8a8"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#af3c6e52e33f4066c751b613f71d8d0b8">initSyslogFacilityStr</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a9fff72c89a4bc7a02b6abe8ec1780e11">syslogFacility</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#ad57f3a73b26a95e4dec1ca822f0c9036">facilityStr</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a1d20f717189f264675a37f109a4a506f">facilityPrinting</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_syslog_writer.html">helpers::SyslogWriter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#ab882875801824b6bd2c76b43dd747da7">sw</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a7c9850c48f6a28ef127d3c1525168f2b">syslogHost</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Use <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html" title="Use SyslogAppender to send log messages to a remote syslog daemon.">SyslogAppender</a> to send log messages to a remote syslog daemon. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae47c980aa543b85d2fb6500b5e7482b5"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::SyslogAppender" ref="ae47c980aa543b85d2fb6500b5e7482b5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html">SyslogAppender</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7e702347ed221f452b5a843e34a9c39e"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::SyslogAppender" ref="a7e702347ed221f452b5a843e34a9c39e" args="(const LayoutPtr &layout, int syslogFacility)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html">SyslogAppender</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> & </td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>syslogFacility</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8ed5850c43c1d0eacf57149b26ecf9cd"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::SyslogAppender" ref="a8ed5850c43c1d0eacf57149b26ecf9cd" args="(const LayoutPtr &layout, const LogString &syslogHost, int syslogFacility)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html">SyslogAppender</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> & </td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>syslogHost</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>syslogFacility</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a73ca108f80997a2278ca8a6a3196b22e"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::~SyslogAppender" ref="a73ca108f80997a2278ca8a6a3196b22e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html">SyslogAppender</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa3df68f8aae152299471992071e202f5"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::activateOptions" ref="aa3df68f8aae152299471992071e202f5" args="(log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void activateOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method returns immediately as options are activated when they are set. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#abe1aa95ede9cc9d0609905154129c0ba">AppenderSkeleton</a>.</p>
</div>
</div>
<a class="anchor" id="a77865c6199c0128510162f6a598f2f41"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::append" ref="a77865c6199c0128510162f6a598f2f41" args="(const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void append </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> & </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subclasses of <code><a class="el" href="classlog4cxx_1_1_appender_skeleton.html" title="Implementation base class for all appenders.">AppenderSkeleton</a></code> should implement this method to perform actual logging. </p>
<p>See also <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#a2df87e9db87ebe5396ea94fb9c25c488" title="This method performs threshold checks and invokes filters before delegating actual logging to the sub...">AppenderSkeleton::doAppend</a> method. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#a4c08a91d859f636117f07463bb53fe41">AppenderSkeleton</a>.</p>
</div>
</div>
<a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::close" ref="a5ae591df94fc66ccb85cbb6565368bca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release any resources held by this <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html" title="Use SyslogAppender to send log messages to a remote syslog daemon.">SyslogAppender</a>. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1_appender.html#af6ee7eacbde6b379b68d954e44f6e549">Appender</a>.</p>
</div>
</div>
<a class="anchor" id="ae73e5e3083de8146ce4c662eb5d89c56"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::getFacility" ref="ae73e5e3083de8146ce4c662eb5d89c56" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getFacility </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value of the <b>Facility</b> option. </p>
</div>
</div>
<a class="anchor" id="a7d398008aef6746228f16915ee9ee8a8"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::getFacility" ref="a7d398008aef6746228f16915ee9ee8a8" args="(const LogString &facilityName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int getFacility </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>facilityName</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the integer value corresponding to the named syslog facility, or -1 if it couldn't be recognized. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">facilityName</td><td>one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. The matching is case-insensitive. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aea55c55a58b3127e4c628c39bc15329c"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::getFacilityPrinting" ref="aea55c55a58b3127e4c628c39bc15329c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getFacilityPrinting </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value of the <b>FacilityPrinting</b> option. </p>
</div>
</div>
<a class="anchor" id="aaf365cb50db7ff7ca2fd5d784dc07e74"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::getFacilityString" ref="aaf365cb50db7ff7ca2fd5d784dc07e74" args="(int syslogFacility)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getFacilityString </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>syslogFacility</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the specified syslog facility as a lower-case String, e.g. </p>
<p>"kern", "user", etc. </p>
</div>
</div>
<a class="anchor" id="a9d8d6e4e39bbc97815537ca470ed02e0"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::getSyslogHost" ref="a9d8d6e4e39bbc97815537ca470ed02e0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>& getSyslogHost </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value of the <b>SyslogHost</b> option. </p>
</div>
</div>
<a class="anchor" id="af3c6e52e33f4066c751b613f71d8d0b8"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::initSyslogFacilityStr" ref="af3c6e52e33f4066c751b613f71d8d0b8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void initSyslogFacilityStr </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4312e727a9ea814779d2c9950dc3c73e"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::requiresLayout" ref="a4312e727a9ea814779d2c9950dc3c73e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool requiresLayout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html" title="Use SyslogAppender to send log messages to a remote syslog daemon.">SyslogAppender</a> requires a layout. </p>
<p>Hence, this method returns <code>true</code>. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1_appender.html#a1fa0a21a0f0a6ec3a9e92a98db9ffa85">Appender</a>.</p>
</div>
</div>
<a class="anchor" id="a8ef6f5fc7bac499368350543740bd38f"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::setFacility" ref="a8ef6f5fc7bac499368350543740bd38f" args="(const LogString &facilityName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setFacility </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>facilityName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the syslog facility. </p>
<p>This is the <b>Facility</b> option.</p>
<p>The <code>facilityName</code> parameter must be one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. Case is unimportant. </p>
</div>
</div>
<a class="anchor" id="aa1452821e8afb10aaa35440a0f13befa"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::setFacilityPrinting" ref="aa1452821e8afb10aaa35440a0f13befa" args="(bool facilityPrinting1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setFacilityPrinting </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>facilityPrinting1</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the <b>FacilityPrinting</b> option is set to true, the printed message will include the facility name of the application. </p>
<p>It is <em>false</em> by default. </p>
</div>
</div>
<a class="anchor" id="ac1d269357907e0809687a2bec962e1c8"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::setOption" ref="ac1d269357907e0809687a2bec962e1c8" args="(const LogString &option, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setOption </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set <code>option</code> to <code>value</code>. </p>
<p>The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#aa3df68f8aae152299471992071e202f5" title="This method returns immediately as options are activated when they are set.">activateOptions</a> is called. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#aee5023c29cca9dc68164b22a01cb7c6e">AppenderSkeleton</a>.</p>
</div>
</div>
<a class="anchor" id="a72536ece7b9003657beca1ff895365ce"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::setSyslogHost" ref="a72536ece7b9003657beca1ff895365ce" args="(const LogString &syslogHost)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setSyslogHost </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>syslogHost</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <b>SyslogHost</b> option is the name of the the syslog host where log output should go. </p>
<p><b>WARNING</b> If the SyslogHost is not set, then this appender will fail. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1d20f717189f264675a37f109a4a506f"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::facilityPrinting" ref="a1d20f717189f264675a37f109a4a506f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a1d20f717189f264675a37f109a4a506f">facilityPrinting</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad57f3a73b26a95e4dec1ca822f0c9036"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::facilityStr" ref="ad57f3a73b26a95e4dec1ca822f0c9036" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#ad57f3a73b26a95e4dec1ca822f0c9036">facilityStr</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab882875801824b6bd2c76b43dd747da7"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::sw" ref="ab882875801824b6bd2c76b43dd747da7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_syslog_writer.html">helpers::SyslogWriter</a>* <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#ab882875801824b6bd2c76b43dd747da7">sw</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9fff72c89a4bc7a02b6abe8ec1780e11"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::syslogFacility" ref="a9fff72c89a4bc7a02b6abe8ec1780e11" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a9fff72c89a4bc7a02b6abe8ec1780e11">syslogFacility</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7c9850c48f6a28ef127d3c1525168f2b"></a><!-- doxytag: member="log4cxx::net::SyslogAppender::syslogHost" ref="a7c9850c48f6a28ef127d3c1525168f2b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#a7c9850c48f6a28ef127d3c1525168f2b">syslogHost</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="syslogappender_8h.html">syslogappender.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1net.html">net</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html">SyslogAppender</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
