<!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.5"/> <title>log4shib: IdsaAppender.hh Source File</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.5 --> <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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><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="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1eb1cafafd84a09ddbe9fda5c5189f10.html">log4shib</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">IdsaAppender.hh</div> </div> </div><!--header--> <div class="contents"> <a href="IdsaAppender_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * IdsaAppender.hh</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright 2000, Marc Welz</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * See the COPYING file for the terms of usage and distribution.</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef _LOG4SHIB_IDSAAPPENDER_HH</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span><span class="preprocessor">#define _LOG4SHIB_IDSAAPPENDER_HH</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <<a class="code" href="Portability_8hh.html">log4shib/Portability.hh</a>></span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <string></span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <stdarg.h></span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <idsa.h></span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <<a class="code" href="AppenderSkeleton_8hh.html">log4shib/AppenderSkeleton.hh</a>></span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>log4shib {</div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> <div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classlog4shib_1_1IdsaAppender.html"> 25</a></span>  <span class="keyword">class </span><a class="code" href="classlog4shib_1_1IdsaAppender.html">IdsaAppender</a> : <span class="keyword">public</span> <a class="code" href="classlog4shib_1_1AppenderSkeleton.html">AppenderSkeleton</a> {</div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classlog4shib_1_1IdsaAppender.html#aa7e27221ea53f3461d2a6cc5d4f79749">IdsaAppender</a>(<span class="keyword">const</span> std::string& name, <span class="keyword">const</span> std::string& idsaName);</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> <a class="code" href="classlog4shib_1_1IdsaAppender.html#a1d6d1de661eb689ddd41b5e4bd7e464b">~IdsaAppender</a>();</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classlog4shib_1_1IdsaAppender.html#ac4c16a7696b0e525d3f43332adb41721">reopen</a>();</div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classlog4shib_1_1IdsaAppender.html#aa57a6bf0d3713dc501570981af309506">close</a>();</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classlog4shib_1_1IdsaAppender.html#a5deda4d679177df9b5a868a7c21c4a81">requiresLayout</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classlog4shib_1_1IdsaAppender.html#a43241308647b48cc61035e97e63734d5">setLayout</a>(<a class="code" href="classlog4shib_1_1Layout.html">Layout</a>* layout);</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">protected</span>:</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classlog4shib_1_1IdsaAppender.html#af33a703611acfbebd27ed9581e18fc35">open</a>();</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classlog4shib_1_1IdsaAppender.html#a4cee089ad29229ed8f309e510baad7ed">_append</a>(<span class="keyword">const</span> <a class="code" href="structlog4shib_1_1LoggingEvent.html">LoggingEvent</a>& event);</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classlog4shib_1_1IdsaAppender.html#a188ad4a211ef0903c258d2afac765666"> 68</a></span>  <span class="keyword">const</span> std::string <a class="code" href="classlog4shib_1_1IdsaAppender.html#a188ad4a211ef0903c258d2afac765666">_idsaName</a>;</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> <div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classlog4shib_1_1IdsaAppender.html#ad09e69dd28c98357465a931ced031e2d"> 70</a></span>  IDSA_CONNECTION *<a class="code" href="classlog4shib_1_1IdsaAppender.html#ad09e69dd28c98357465a931ced031e2d">_idsaConnection</a>;</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  };</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif // _LOG4SHIB_IDSAAPPENDER_HH</span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html">log4shib::IdsaAppender</a></div><div class="ttdoc">IdsaAppender is an Appender that sends LoggingEvents to the IDS/A logger and reference monitor by Mar...</div><div class="ttdef"><b>Definition:</b> IdsaAppender.hh:25</div></div> <div class="ttc" id="structlog4shib_1_1LoggingEvent_html"><div class="ttname"><a href="structlog4shib_1_1LoggingEvent.html">log4shib::LoggingEvent</a></div><div class="ttdoc">The internal representation of logging events. </div><div class="ttdef"><b>Definition:</b> LoggingEvent.hh:32</div></div> <div class="ttc" id="AppenderSkeleton_8hh_html"><div class="ttname"><a href="AppenderSkeleton_8hh.html">AppenderSkeleton.hh</a></div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_a5deda4d679177df9b5a868a7c21c4a81"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#a5deda4d679177df9b5a868a7c21c4a81">log4shib::IdsaAppender::requiresLayout</a></div><div class="ttdeci">virtual bool requiresLayout() const </div><div class="ttdoc">The IdsaAppender does its own Layout. </div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_ad09e69dd28c98357465a931ced031e2d"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#ad09e69dd28c98357465a931ced031e2d">log4shib::IdsaAppender::_idsaConnection</a></div><div class="ttdeci">IDSA_CONNECTION * _idsaConnection</div><div class="ttdef"><b>Definition:</b> IdsaAppender.hh:70</div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_a4cee089ad29229ed8f309e510baad7ed"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#a4cee089ad29229ed8f309e510baad7ed">log4shib::IdsaAppender::_append</a></div><div class="ttdeci">virtual void _append(const LoggingEvent &event)</div><div class="ttdoc">Sends a LoggingEvent to idsa. </div></div> <div class="ttc" id="Portability_8hh_html"><div class="ttname"><a href="Portability_8hh.html">Portability.hh</a></div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_a43241308647b48cc61035e97e63734d5"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#a43241308647b48cc61035e97e63734d5">log4shib::IdsaAppender::setLayout</a></div><div class="ttdeci">virtual void setLayout(Layout *layout)</div><div class="ttdoc">Set the Layout for this appender. </div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_ac4c16a7696b0e525d3f43332adb41721"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#ac4c16a7696b0e525d3f43332adb41721">log4shib::IdsaAppender::reopen</a></div><div class="ttdeci">virtual bool reopen()</div><div class="ttdoc">Calls idsa_open() and idsa_close() </div></div> <div class="ttc" id="classlog4shib_1_1AppenderSkeleton_html"><div class="ttname"><a href="classlog4shib_1_1AppenderSkeleton.html">log4shib::AppenderSkeleton</a></div><div class="ttdoc">AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already takes care of...</div><div class="ttdef"><b>Definition:</b> AppenderSkeleton.hh:24</div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_a1d6d1de661eb689ddd41b5e4bd7e464b"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#a1d6d1de661eb689ddd41b5e4bd7e464b">log4shib::IdsaAppender::~IdsaAppender</a></div><div class="ttdeci">virtual ~IdsaAppender()</div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_aa7e27221ea53f3461d2a6cc5d4f79749"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#aa7e27221ea53f3461d2a6cc5d4f79749">log4shib::IdsaAppender::IdsaAppender</a></div><div class="ttdeci">IdsaAppender(const std::string &name, const std::string &idsaName)</div><div class="ttdoc">Instantiate an IdsaAppender with given name and name. </div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_aa57a6bf0d3713dc501570981af309506"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#aa57a6bf0d3713dc501570981af309506">log4shib::IdsaAppender::close</a></div><div class="ttdeci">virtual void close()</div><div class="ttdoc">Calls idsa_close() </div></div> <div class="ttc" id="classlog4shib_1_1Layout_html"><div class="ttname"><a href="classlog4shib_1_1Layout.html">log4shib::Layout</a></div><div class="ttdoc">Extend this abstract class to create your own log layout format. </div><div class="ttdef"><b>Definition:</b> Layout.hh:22</div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_af33a703611acfbebd27ed9581e18fc35"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#af33a703611acfbebd27ed9581e18fc35">log4shib::IdsaAppender::open</a></div><div class="ttdeci">virtual void open()</div><div class="ttdoc">Calls idsa_open(). </div></div> <div class="ttc" id="classlog4shib_1_1IdsaAppender_html_a188ad4a211ef0903c258d2afac765666"><div class="ttname"><a href="classlog4shib_1_1IdsaAppender.html#a188ad4a211ef0903c258d2afac765666">log4shib::IdsaAppender::_idsaName</a></div><div class="ttdeci">const std::string _idsaName</div><div class="ttdef"><b>Definition:</b> IdsaAppender.hh:68</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sat Oct 19 2013 07:04:31 for log4shib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>