<!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: log4shib::Priority 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.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 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_1Priority.html">Priority</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classlog4shib_1_1Priority-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">log4shib::Priority Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classlog4shib_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages. ">Priority</a> class provides importance levels with which one can categorize log messages.
<a href="classlog4shib_1_1Priority.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Priority_8hh_source.html">Priority.hh</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0c93eada3fec209680988abdde4230e7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7">PriorityLevel</a> { <br/>
  <a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7a2a5ca219dd75d62985cde494501e5c3b">EMERG</a> = 0,
<a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7a6b73366f9b321cbb541eb2d2f2054aef">FATAL</a> = 0,
<a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7a86932a3f6859d0f06966432d50b261e2">ALERT</a> = 100,
<a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7ab4434e1db477e5812c50a792c9346976">CRIT</a> = 200,
<br/>
  <a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7a69b365cdde80ee2734bb27aad0e4d64e">ERROR</a> = 300,
<a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7a3b87a2899ea101ef8bf2e0881113ec71">WARN</a> = 400,
<a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7acebdfbd6fe11e880f65c3d587e36aeb2">NOTICE</a> = 500,
<a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7aee1244cadac1085b1b60273eaf285920">INFO</a> = 600,
<br/>
  <a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7aaed6759d9a6f4101a2fb43f4e22aeda1">DEBUG</a> = 700,
<a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7a5cf392e9207ff6e9beb7293e0bc0df00">NOTSET</a> = 800
<br/>
}</td></tr>
<tr class="memdesc:a0c93eada3fec209680988abdde4230e7"><td class="mdescLeft"> </td><td class="mdescRight">Predefined Levels of Priorities. <a href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7">More...</a><br/></td></tr>
<tr class="separator:a0c93eada3fec209680988abdde4230e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52f9e246405983136cbb07512ba67f21"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Value</a></td></tr>
<tr class="memdesc:a52f9e246405983136cbb07512ba67f21"><td class="mdescLeft"> </td><td class="mdescRight">The type of <a class="el" href="classlog4shib_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages. ">Priority</a> Values. <a href="#a52f9e246405983136cbb07512ba67f21">More...</a><br/></td></tr>
<tr class="separator:a52f9e246405983136cbb07512ba67f21"><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:aed7546135f73a489daf7990a46619592"><td class="memItemLeft" align="right" valign="top">static const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Priority.html#aed7546135f73a489daf7990a46619592">getPriorityName</a> (int priority) throw ()</td></tr>
<tr class="memdesc:aed7546135f73a489daf7990a46619592"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the given priority value. <a href="#aed7546135f73a489daf7990a46619592">More...</a><br/></td></tr>
<tr class="separator:aed7546135f73a489daf7990a46619592"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af36ed9732299b92deea3b4bac87bf86d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1Priority.html#af36ed9732299b92deea3b4bac87bf86d">getPriorityValue</a> (const std::string &priorityName) throw (std::invalid_argument)</td></tr>
<tr class="memdesc:af36ed9732299b92deea3b4bac87bf86d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the given priority name. <a href="#af36ed9732299b92deea3b4bac87bf86d">More...</a><br/></td></tr>
<tr class="separator:af36ed9732299b92deea3b4bac87bf86d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classlog4shib_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages. ">Priority</a> class provides importance levels with which one can categorize log messages. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a52f9e246405983136cbb07512ba67f21"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">log4shib::Priority::Value</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of <a class="el" href="classlog4shib_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages. ">Priority</a> Values. </p>
</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a0c93eada3fec209680988abdde4230e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7">log4shib::Priority::PriorityLevel</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Predefined Levels of Priorities. </p>
<p>These correspond to the priority levels used by syslog(3). </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7a2a5ca219dd75d62985cde494501e5c3b"></a>EMERG</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7a6b73366f9b321cbb541eb2d2f2054aef"></a>FATAL</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7a86932a3f6859d0f06966432d50b261e2"></a>ALERT</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7ab4434e1db477e5812c50a792c9346976"></a>CRIT</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7a69b365cdde80ee2734bb27aad0e4d64e"></a>ERROR</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7a3b87a2899ea101ef8bf2e0881113ec71"></a>WARN</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7acebdfbd6fe11e880f65c3d587e36aeb2"></a>NOTICE</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7aee1244cadac1085b1b60273eaf285920"></a>INFO</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7aaed6759d9a6f4101a2fb43f4e22aeda1"></a>DEBUG</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0c93eada3fec209680988abdde4230e7a5cf392e9207ff6e9beb7293e0bc0df00"></a>NOTSET</em> </td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aed7546135f73a489daf7990a46619592"></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::Priority::getPriorityName </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>priority</em></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"></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>Returns the name of the given priority value. </p>
<p>Currently, if the value is not one of the PriorityLevel values, the method returns the name of the largest priority smaller the given value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">priority</td><td>the numeric value of the priority. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string representing the name of the priority. </dd></dl>
</div>
</div>
<a class="anchor" id="af36ed9732299b92deea3b4bac87bf86d"></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_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> log4shib::Priority::getPriorityValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>priorityName</em></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2">std::invalid_argument</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>Returns the value of the given priority name. </p>
<p>This can be either one of EMERG ... NOTSET or a decimal string representation of the value, e.g. '700' for DEBUG. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">priorityName</td><td>the string containing the the of the priority </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value corresponding with the priority name </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::invalid_argument</td><td>if the priorityName does not correspond with a known <a class="el" href="classlog4shib_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages. ">Priority</a> name or a number </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="Priority_8hh_source.html">Priority.hh</a></li>
<li><a class="el" href="Priority_8cpp.html">Priority.cpp</a></li>
</ul>
</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>
