<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>log4shib: log4shib::Appender Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">log4shib
 <span id="projectnumber">1.0.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4shib.html">log4shib</a></li><li class="navelem"><a class="el" href="classlog4shib_1_1Appender.html">Appender</a></li> </ul>
</div>
</div><!-- top -->
<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="classlog4shib_1_1Appender-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">log4shib::Appender Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Implement this interface for your own strategies for printing log statements.
<a href="classlog4shib_1_1Appender.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Appender_8hh_source.html">Appender.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for log4shib::Appender:</div>
<div class="dyncontent">
<div class="center">
<img src="classlog4shib_1_1Appender.png" usemap="#log4shib::Appender_map" alt=""/>
<map id="log4shib::Appender_map" name="log4shib::Appender_map">
<area href="classlog4shib_1_1AppenderSkeleton.html" title="AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already takes care of..." alt="log4shib::AppenderSkeleton" shape="rect" coords="367,56,567,80"/>
<area href="classlog4shib_1_1AbortAppender.html" title="This Appender causes the application to abort() upon the first append() call. " alt="log4shib::AbortAppender" shape="rect" coords="0,112,200,136"/>
<area href="classlog4shib_1_1IdsaAppender.html" title="IdsaAppender is an Appender that sends LoggingEvents to the IDS/A logger and reference monitor by Mar..." alt="log4shib::IdsaAppender" shape="rect" coords="210,112,410,136"/>
<area href="classlog4shib_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout. " alt="log4shib::LayoutAppender" shape="rect" coords="525,112,725,136"/>
<area href="classlog4shib_1_1NTEventLogAppender.html" title="NTEventLogAppender is an Appender that sends LoggingEvents to the Windows event log. " alt="log4shib::NTEventLogAppender" shape="rect" coords="735,112,935,136"/>
<area href="classlog4shib_1_1FileAppender.html" alt="log4shib::FileAppender" shape="rect" coords="0,168,200,192"/>
<area href="classlog4shib_1_1OstreamAppender.html" title="OstreamAppender appends LoggingEvents to ostreams. " alt="log4shib::OstreamAppender" shape="rect" coords="210,168,410,192"/>
<area href="classlog4shib_1_1RemoteSyslogAppender.html" title="RemoteSyslogAppender sends LoggingEvents to a remote syslog system. " alt="log4shib::RemoteSyslogAppender" shape="rect" coords="420,168,620,192"/>
<area href="classlog4shib_1_1StringQueueAppender.html" title="This class puts log messages in an in-memory queue. " alt="log4shib::StringQueueAppender" shape="rect" coords="630,168,830,192"/>
<area href="classlog4shib_1_1SyslogAppender.html" title="SyslogAppender sends LoggingEvents to the local syslog system. " alt="log4shib::SyslogAppender" shape="rect" coords="840,168,1040,192"/>
<area href="classlog4shib_1_1Win32DebugAppender.html" title="Win32DebugAppender simply sends the log message to the default system debugger on Win32 systems..." alt="log4shib::Win32DebugAppender" shape="rect" coords="1050,168,1250,192"/>
<area href="classlog4shib_1_1RollingFileAppender.html" title="RollingFileAppender is a FileAppender that rolls over the logfile once it has reached a certain size ..." alt="log4shib::RollingFileAppender" shape="rect" coords="0,224,200,248"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8567784d15f6c21cb3751eaeeed206d6"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#a8567784d15f6c21cb3751eaeeed206d6">~Appender</a> ()</td></tr>
<tr class="memdesc:a8567784d15f6c21cb3751eaeeed206d6"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. <a href="#a8567784d15f6c21cb3751eaeeed206d6">More...</a><br /></td></tr>
<tr class="separator:a8567784d15f6c21cb3751eaeeed206d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2388324720d73479f2a7fc5352213a1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#ac2388324720d73479f2a7fc5352213a1">doAppend</a> (const <a class="el" href="structlog4shib_1_1LoggingEvent.html">LoggingEvent</a> &event)=0</td></tr>
<tr class="memdesc:ac2388324720d73479f2a7fc5352213a1"><td class="mdescLeft"> </td><td class="mdescRight">Log in <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a> specific way. <a href="#ac2388324720d73479f2a7fc5352213a1">More...</a><br /></td></tr>
<tr class="separator:ac2388324720d73479f2a7fc5352213a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedbd45b2687a9697f58d2628bca79e9e"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#aedbd45b2687a9697f58d2628bca79e9e">reopen</a> ()=0</td></tr>
<tr class="memdesc:aedbd45b2687a9697f58d2628bca79e9e"><td class="mdescLeft"> </td><td class="mdescRight">Reopens the output destination of this <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>, e.g. <a href="#aedbd45b2687a9697f58d2628bca79e9e">More...</a><br /></td></tr>
<tr class="separator:aedbd45b2687a9697f58d2628bca79e9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7faa06d51a84a4dc5b0a6871b7f5759f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#a7faa06d51a84a4dc5b0a6871b7f5759f">close</a> ()=0</td></tr>
<tr class="memdesc:a7faa06d51a84a4dc5b0a6871b7f5759f"><td class="mdescLeft"> </td><td class="mdescRight">Release any resources allocated within the appender such as file handles, network connections, etc. <a href="#a7faa06d51a84a4dc5b0a6871b7f5759f">More...</a><br /></td></tr>
<tr class="separator:a7faa06d51a84a4dc5b0a6871b7f5759f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7c6f7a192f0ef6c549d432c8e83bc34"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#af7c6f7a192f0ef6c549d432c8e83bc34">requiresLayout</a> () const =0</td></tr>
<tr class="memdesc:af7c6f7a192f0ef6c549d432c8e83bc34"><td class="mdescLeft"> </td><td class="mdescRight">Check if the appender uses a layout. <a href="#af7c6f7a192f0ef6c549d432c8e83bc34">More...</a><br /></td></tr>
<tr class="separator:af7c6f7a192f0ef6c549d432c8e83bc34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d3697052e758936d0b93260345aad33"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#a9d3697052e758936d0b93260345aad33">setLayout</a> (<a class="el" href="classlog4shib_1_1Layout.html">Layout</a> *layout)=0</td></tr>
<tr class="memdesc:a9d3697052e758936d0b93260345aad33"><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classlog4shib_1_1Layout.html" title="Extend this abstract class to create your own log layout format. ">Layout</a> for this appender. <a href="#a9d3697052e758936d0b93260345aad33">More...</a><br /></td></tr>
<tr class="separator:a9d3697052e758936d0b93260345aad33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acacc56f74847a7ab89961fb02eb00511"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#acacc56f74847a7ab89961fb02eb00511">getName</a> () const </td></tr>
<tr class="memdesc:acacc56f74847a7ab89961fb02eb00511"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of this appender. <a href="#acacc56f74847a7ab89961fb02eb00511">More...</a><br /></td></tr>
<tr class="separator:acacc56f74847a7ab89961fb02eb00511"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4d77c62f99b8d151a57906eb64754c3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#af4d77c62f99b8d151a57906eb64754c3">setThreshold</a> (<a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> priority)=0</td></tr>
<tr class="memdesc:af4d77c62f99b8d151a57906eb64754c3"><td class="mdescLeft"> </td><td class="mdescRight">Set the threshold priority of this <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. <a href="#af4d77c62f99b8d151a57906eb64754c3">More...</a><br /></td></tr>
<tr class="separator:af4d77c62f99b8d151a57906eb64754c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6ee3ca605294cba008773d7a0f2a9ab"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#ac6ee3ca605294cba008773d7a0f2a9ab">getThreshold</a> ()=0</td></tr>
<tr class="memdesc:ac6ee3ca605294cba008773d7a0f2a9ab"><td class="mdescLeft"> </td><td class="mdescRight">Get the threshold priority of this <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. <a href="#ac6ee3ca605294cba008773d7a0f2a9ab">More...</a><br /></td></tr>
<tr class="separator:ac6ee3ca605294cba008773d7a0f2a9ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a506a2cef27d69b77dcd82a6d610e01bb"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#a506a2cef27d69b77dcd82a6d610e01bb">setFilter</a> (<a class="el" href="classlog4shib_1_1Filter.html">Filter</a> *filter)=0</td></tr>
<tr class="memdesc:a506a2cef27d69b77dcd82a6d610e01bb"><td class="mdescLeft"> </td><td class="mdescRight">Set a <a class="el" href="classlog4shib_1_1Filter.html" title="Users should extend this class to implement customized logging event filtering. ">Filter</a> for this appender. <a href="#a506a2cef27d69b77dcd82a6d610e01bb">More...</a><br /></td></tr>
<tr class="separator:a506a2cef27d69b77dcd82a6d610e01bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae3e0fa8168a0de6252ed7d6bcfe318d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlog4shib_1_1Filter.html">Filter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#aae3e0fa8168a0de6252ed7d6bcfe318d">getFilter</a> ()=0</td></tr>
<tr class="memdesc:aae3e0fa8168a0de6252ed7d6bcfe318d"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classlog4shib_1_1Filter.html" title="Users should extend this class to implement customized logging event filtering. ">Filter</a> for this appender. <a href="#aae3e0fa8168a0de6252ed7d6bcfe318d">More...</a><br /></td></tr>
<tr class="separator:aae3e0fa8168a0de6252ed7d6bcfe318d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac6d3ab5c1c7a2e6f04f020bd0991b754"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classlog4shib_1_1Appender.html">Appender</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#ac6d3ab5c1c7a2e6f04f020bd0991b754">getAppender</a> (const std::string &name)</td></tr>
<tr class="memdesc:ac6d3ab5c1c7a2e6f04f020bd0991b754"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to an exitsing <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. <a href="#ac6d3ab5c1c7a2e6f04f020bd0991b754">More...</a><br /></td></tr>
<tr class="separator:ac6d3ab5c1c7a2e6f04f020bd0991b754"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79929ceb43240137d3f24db2917dba8a"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#a79929ceb43240137d3f24db2917dba8a">reopenAll</a> ()</td></tr>
<tr class="memdesc:a79929ceb43240137d3f24db2917dba8a"><td class="mdescLeft"> </td><td class="mdescRight">Call <a class="el" href="classlog4shib_1_1Appender.html#aedbd45b2687a9697f58d2628bca79e9e" title="Reopens the output destination of this Appender, e.g. ">reopen()</a> on all existing Appenders. <a href="#a79929ceb43240137d3f24db2917dba8a">More...</a><br /></td></tr>
<tr class="separator:a79929ceb43240137d3f24db2917dba8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4edbe47492a8f2515411d2954e61f945"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#a4edbe47492a8f2515411d2954e61f945">closeAll</a> ()</td></tr>
<tr class="memdesc:a4edbe47492a8f2515411d2954e61f945"><td class="mdescLeft"> </td><td class="mdescRight">Call <a class="el" href="classlog4shib_1_1Appender.html#aedbd45b2687a9697f58d2628bca79e9e" title="Reopens the output destination of this Appender, e.g. ">reopen()</a> on all existing Appenders. <a href="#a4edbe47492a8f2515411d2954e61f945">More...</a><br /></td></tr>
<tr class="separator:a4edbe47492a8f2515411d2954e61f945"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a8826498376089b4c62752c3a13522176"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Appender.html#a8826498376089b4c62752c3a13522176">Appender</a> (const std::string &name)</td></tr>
<tr class="memdesc:a8826498376089b4c62752c3a13522176"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. <a href="#a8826498376089b4c62752c3a13522176">More...</a><br /></td></tr>
<tr class="separator:a8826498376089b4c62752c3a13522176"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implement this interface for your own strategies for printing log statements. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8826498376089b4c62752c3a13522176"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">log4shib::Appender::Appender </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. </p>
<p>Will only be used in <a class="el" href="classlog4shib_1_1Appender.html#ac6d3ab5c1c7a2e6f04f020bd0991b754" title="Get a pointer to an exitsing Appender. ">getAppender()</a> (and in derived classes of course). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of this <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8567784d15f6c21cb3751eaeeed206d6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">log4shib::Appender::~Appender </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor for <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7faa06d51a84a4dc5b0a6871b7f5759f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void log4shib::Appender::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Release any resources allocated within the appender such as file handles, network connections, etc. </p>
<p>Implemented in <a class="el" href="classlog4shib_1_1RemoteSyslogAppender.html#a2349c8de8a438d61205bf834e1297b64">log4shib::RemoteSyslogAppender</a>, <a class="el" href="classlog4shib_1_1NTEventLogAppender.html#ab490f5fffaa6feef3ed21122eaa3f150">log4shib::NTEventLogAppender</a>, <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#a85e29c4e0f8f789f6ff47e6310b18250">log4shib::AppenderSkeleton</a>, <a class="el" href="classlog4shib_1_1SyslogAppender.html#a41117641a8b51fa64eaad2ae3badd9ea">log4shib::SyslogAppender</a>, <a class="el" href="classlog4shib_1_1FileAppender.html#ad84ac20e1c3fde9f4b86fa939d625eb4">log4shib::FileAppender</a>, <a class="el" href="classlog4shib_1_1IdsaAppender.html#aa57a6bf0d3713dc501570981af309506">log4shib::IdsaAppender</a>, <a class="el" href="classlog4shib_1_1Win32DebugAppender.html#a0810866c1fc56063fab5ea5c5a4a90b9">log4shib::Win32DebugAppender</a>, <a class="el" href="classlog4shib_1_1StringQueueAppender.html#a2653cd14c1695e755f3c4add64ff2431">log4shib::StringQueueAppender</a>, <a class="el" href="classlog4shib_1_1AbortAppender.html#ac5b00e35771abfe39fa620469b6038e7">log4shib::AbortAppender</a>, and <a class="el" href="classlog4shib_1_1OstreamAppender.html#a617f4a8fb17baa3b9f0ce7c99a1e3429">log4shib::OstreamAppender</a>.</p>
</div>
</div>
<a class="anchor" id="a4edbe47492a8f2515411d2954e61f945"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::Appender::closeAll </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Call <a class="el" href="classlog4shib_1_1Appender.html#aedbd45b2687a9697f58d2628bca79e9e" title="Reopens the output destination of this Appender, e.g. ">reopen()</a> on all existing Appenders. </p>
<dl class="section return"><dt>Returns</dt><dd>true if all Appenders returned true on their <a class="el" href="classlog4shib_1_1Appender.html#aedbd45b2687a9697f58d2628bca79e9e" title="Reopens the output destination of this Appender, e.g. ">reopen()</a> call. </dd></dl>
</div>
</div>
<a class="anchor" id="ac2388324720d73479f2a7fc5352213a1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void log4shib::Appender::doAppend </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlog4shib_1_1LoggingEvent.html">LoggingEvent</a> & </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Log in <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a> specific way. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>The <a class="el" href="structlog4shib_1_1LoggingEvent.html" title="The internal representation of logging events. ">LoggingEvent</a> to log. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#a5319e93c95fcbb5f89c5746c93150856">log4shib::AppenderSkeleton</a>.</p>
</div>
</div>
<a class="anchor" id="ac6d3ab5c1c7a2e6f04f020bd0991b754"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4shib_1_1Appender.html">Appender</a> * log4shib::Appender::getAppender </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to an exitsing <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a> to return. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to an existing <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>, or NULL if no appender with the specfied name exists. </dd></dl>
</div>
</div>
<a class="anchor" id="aae3e0fa8168a0de6252ed7d6bcfe318d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classlog4shib_1_1Filter.html">Filter</a>* log4shib::Appender::getFilter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the <a class="el" href="classlog4shib_1_1Filter.html" title="Users should extend this class to implement customized logging event filtering. ">Filter</a> for this appender. </p>
<dl class="section return"><dt>Returns</dt><dd>the filter, or NULL if no filter has been set. </dd></dl>
<p>Implemented in <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#a63036494d9003049f5366b0d988d368c">log4shib::AppenderSkeleton</a>.</p>
</div>
</div>
<a class="anchor" id="acacc56f74847a7ab89961fb02eb00511"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string& log4shib::Appender::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of this appender. </p>
<p>The name identifies the appender. </p><dl class="section return"><dt>Returns</dt><dd>the name of the appender. </dd></dl>
</div>
</div>
<a class="anchor" id="ac6ee3ca605294cba008773d7a0f2a9ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> log4shib::Appender::getThreshold </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the threshold priority of this <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>the threshold </dd></dl>
<p>Implemented in <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#af2bfb3f9ecee5b325a6bdfac204249b1">log4shib::AppenderSkeleton</a>.</p>
</div>
</div>
<a class="anchor" id="aedbd45b2687a9697f58d2628bca79e9e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool log4shib::Appender::reopen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reopens the output destination of this <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>, e.g. </p>
<p>the logfile or TCP socket. </p><dl class="section return"><dt>Returns</dt><dd>false if an error occured during reopening, true otherwise. </dd></dl>
<p>Implemented in <a class="el" href="classlog4shib_1_1RemoteSyslogAppender.html#a772c64d9cd9c3e06b1dd5f51aef3c775">log4shib::RemoteSyslogAppender</a>, <a class="el" href="classlog4shib_1_1NTEventLogAppender.html#a000c1559c645b9914f6e5e292c1c7f7b">log4shib::NTEventLogAppender</a>, <a class="el" href="classlog4shib_1_1SyslogAppender.html#a7e5bf6651dd1871cefe009ac1a9b3a20">log4shib::SyslogAppender</a>, <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#a97ee387d96191e44c88e8f3f41cfe4ed">log4shib::AppenderSkeleton</a>, <a class="el" href="classlog4shib_1_1FileAppender.html#a5a6554dd0e0bcee0814ff54db3787f83">log4shib::FileAppender</a>, <a class="el" href="classlog4shib_1_1IdsaAppender.html#ac4c16a7696b0e525d3f43332adb41721">log4shib::IdsaAppender</a>, <a class="el" href="classlog4shib_1_1StringQueueAppender.html#a418ace417d83ada53b4fb47b0323e81b">log4shib::StringQueueAppender</a>, <a class="el" href="classlog4shib_1_1AbortAppender.html#ac0bd63d80c36aa9114edcf285584fbc5">log4shib::AbortAppender</a>, and <a class="el" href="classlog4shib_1_1OstreamAppender.html#aa96a158a729a3eed745b977f0714761f">log4shib::OstreamAppender</a>.</p>
</div>
</div>
<a class="anchor" id="a79929ceb43240137d3f24db2917dba8a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool log4shib::Appender::reopenAll </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Call <a class="el" href="classlog4shib_1_1Appender.html#aedbd45b2687a9697f58d2628bca79e9e" title="Reopens the output destination of this Appender, e.g. ">reopen()</a> on all existing Appenders. </p>
<dl class="section return"><dt>Returns</dt><dd>true if all Appenders returned true on their <a class="el" href="classlog4shib_1_1Appender.html#aedbd45b2687a9697f58d2628bca79e9e" title="Reopens the output destination of this Appender, e.g. ">reopen()</a> call. </dd></dl>
</div>
</div>
<a class="anchor" id="af7c6f7a192f0ef6c549d432c8e83bc34"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool log4shib::Appender::requiresLayout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the appender uses a layout. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the appender implementation requires a layout. </dd></dl>
<p>Implemented in <a class="el" href="classlog4shib_1_1NTEventLogAppender.html#a8334726abb7b4e9024772ea0393ce4e0">log4shib::NTEventLogAppender</a>, <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#a6cf4e3b1bbcdbbec0cc0d7f678fd64b2">log4shib::AppenderSkeleton</a>, <a class="el" href="classlog4shib_1_1IdsaAppender.html#a5deda4d679177df9b5a868a7c21c4a81">log4shib::IdsaAppender</a>, <a class="el" href="classlog4shib_1_1LayoutAppender.html#a57c12dee4e0a5d74738ade54c3ee92ec">log4shib::LayoutAppender</a>, and <a class="el" href="classlog4shib_1_1AbortAppender.html#a1cb0cd389bbf35e82096183450df87f9">log4shib::AbortAppender</a>.</p>
</div>
</div>
<a class="anchor" id="a506a2cef27d69b77dcd82a6d610e01bb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void log4shib::Appender::setFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4shib_1_1Filter.html">Filter</a> * </td>
<td class="paramname"><em>filter</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a <a class="el" href="classlog4shib_1_1Filter.html" title="Users should extend this class to implement customized logging event filtering. ">Filter</a> for this appender. </p>
<p>Implemented in <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#a974578695b811df8562a53bfab232237">log4shib::AppenderSkeleton</a>.</p>
</div>
</div>
<a class="anchor" id="a9d3697052e758936d0b93260345aad33"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void log4shib::Appender::setLayout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4shib_1_1Layout.html">Layout</a> * </td>
<td class="paramname"><em>layout</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the <a class="el" href="classlog4shib_1_1Layout.html" title="Extend this abstract class to create your own log layout format. ">Layout</a> for this appender. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">layout</td><td>The layout to use. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classlog4shib_1_1NTEventLogAppender.html#ad67170b65db3aa789c007865f66c3133">log4shib::NTEventLogAppender</a>, <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#ac991533b52fadf679823d8e857c2a5a5">log4shib::AppenderSkeleton</a>, <a class="el" href="classlog4shib_1_1IdsaAppender.html#a43241308647b48cc61035e97e63734d5">log4shib::IdsaAppender</a>, <a class="el" href="classlog4shib_1_1AbortAppender.html#a19d30478570436bc062608d2114ddd2f">log4shib::AbortAppender</a>, and <a class="el" href="classlog4shib_1_1LayoutAppender.html#ae4ebb090462d2ff9921539130acfa355">log4shib::LayoutAppender</a>.</p>
</div>
</div>
<a class="anchor" id="af4d77c62f99b8d151a57906eb64754c3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void log4shib::Appender::setThreshold </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> </td>
<td class="paramname"><em>priority</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the threshold priority of this <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a>. </p>
<p>The <a class="el" href="classlog4shib_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements. ">Appender</a> will not appender LoggingEvents with a priority lower than the threshold. Use <a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7a5cf392e9207ff6e9beb7293e0bc0df00">Priority::NOTSET</a> to disable threshold checking. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">priority</td><td>The priority to set. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classlog4shib_1_1AppenderSkeleton.html#ae8beec922c563cf419e7dc6985fe8504">log4shib::AppenderSkeleton</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Appender_8hh_source.html">Appender.hh</a></li>
<li><a class="el" href="Appender_8cpp.html">Appender.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 16 2014 02:10:55 for log4shib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
470b3588132cd9082e1e9eed34a6511e
>
files
>
188
