<!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::SimpleConfigurator 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_1SimpleConfigurator.html">SimpleConfigurator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classlog4shib_1_1SimpleConfigurator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">log4shib::SimpleConfigurator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class implements a simple Configurator for <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a>.
<a href="classlog4shib_1_1SimpleConfigurator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="SimpleConfigurator_8hh_source.html">SimpleConfigurator.hh</a>></code></p>
<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:ae8515572fa55d0744f6d8a79588bfd13"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1SimpleConfigurator.html#ae8515572fa55d0744f6d8a79588bfd13">configure</a> (const std::string &initFileName) throw (ConfigureFailure)</td></tr>
<tr class="memdesc:ae8515572fa55d0744f6d8a79588bfd13"><td class="mdescLeft"> </td><td class="mdescRight">Configure <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a> with the configuration in the given file. <a href="#ae8515572fa55d0744f6d8a79588bfd13">More...</a><br /></td></tr>
<tr class="separator:ae8515572fa55d0744f6d8a79588bfd13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade721ed2b66bcd9517d6b6bf260450c3"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1SimpleConfigurator.html#ade721ed2b66bcd9517d6b6bf260450c3">configure</a> (std::istream &initFile) throw (ConfigureFailure)</td></tr>
<tr class="memdesc:ade721ed2b66bcd9517d6b6bf260450c3"><td class="mdescLeft"> </td><td class="mdescRight">Configure <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a> with the configuration in the given file. <a href="#ade721ed2b66bcd9517d6b6bf260450c3">More...</a><br /></td></tr>
<tr class="separator:ade721ed2b66bcd9517d6b6bf260450c3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class implements a simple Configurator for <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a>. </p>
<p>It is a temporary hack with an undocumented configuration format. </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>As of version 0.3.2 <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a> includes a log4j format compatible <a class="el" href="classlog4shib_1_1PropertyConfigurator.html" title="Property configurator will read a config file using the same (or similar) format to the config file u...">PropertyConfigurator</a>, removing the need for <a class="el" href="classlog4shib_1_1SimpleConfigurator.html" title="This class implements a simple Configurator for log4shib. ">SimpleConfigurator</a>. This class will be removed in 0.4.0. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae8515572fa55d0744f6d8a79588bfd13"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::SimpleConfigurator::configure </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>initFileName</em></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="classlog4shib_1_1ConfigureFailure.html">ConfigureFailure</a></td>
</tr>
<tr>
<td align="right"></td><td>)</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>Configure <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a> with the configuration in the given file. </p>
<p>NB. The configuration file format is undocumented and may change without notice. </p><dl class="section since"><dt>Since</dt><dd>0.2.6 </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">initFileName</td><td>name of the configuration file </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classlog4shib_1_1ConfigureFailure.html" title="Exception class for configuration. ">ConfigureFailure</a></td><td>if the method encountered a read or syntax error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ade721ed2b66bcd9517d6b6bf260450c3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::SimpleConfigurator::configure </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>initFile</em></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="classlog4shib_1_1ConfigureFailure.html">ConfigureFailure</a></td>
</tr>
<tr>
<td align="right"></td><td>)</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>Configure <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a> with the configuration in the given file. </p>
<p>NB. The configuration file format is undocumented and may change without notice. </p><dl class="section since"><dt>Since</dt><dd>0.3.1 </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">initFile</td><td>an input stream to the configuration file </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classlog4shib_1_1ConfigureFailure.html" title="Exception class for configuration. ">ConfigureFailure</a></td><td>if the method encountered a read or syntax error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="SimpleConfigurator_8hh_source.html">SimpleConfigurator.hh</a></li>
<li><a class="el" href="SimpleConfigurator_8cpp.html">SimpleConfigurator.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
>
255
