<!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::LoggingEvent Struct 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="structlog4shib_1_1LoggingEvent.html">LoggingEvent</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structlog4shib_1_1LoggingEvent-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">log4shib::LoggingEvent Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The internal representation of logging events.
<a href="structlog4shib_1_1LoggingEvent.html#details">More...</a></p>
<p><code>#include <<a class="el" href="LoggingEvent_8hh_source.html">LoggingEvent.hh</a>></code></p>
<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:abd805b8da1feeed7ab4207179edca4d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4shib_1_1LoggingEvent.html#abd805b8da1feeed7ab4207179edca4d3">LoggingEvent</a> (const std::string &category, const std::string &<a class="el" href="structlog4shib_1_1LoggingEvent.html#a940672ee38947e5dd9e12bb26adf4047">message</a>, const std::string &<a class="el" href="structlog4shib_1_1LoggingEvent.html#a1032fae7ecb3d056ba071060b317e015">ndc</a>, <a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> <a class="el" href="structlog4shib_1_1LoggingEvent.html#ab86521694736c50214aa6621f0c491fd">priority</a>)</td></tr>
<tr class="memdesc:abd805b8da1feeed7ab4207179edca4d3"><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <a class="el" href="structlog4shib_1_1LoggingEvent.html" title="The internal representation of logging events. ">LoggingEvent</a> from the supplied parameters. <a href="#abd805b8da1feeed7ab4207179edca4d3">More...</a><br/></td></tr>
<tr class="separator:abd805b8da1feeed7ab4207179edca4d3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aff77028c1c7d6101336f30f7a0c97ffb"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4shib_1_1LoggingEvent.html#aff77028c1c7d6101336f30f7a0c97ffb">categoryName</a></td></tr>
<tr class="memdesc:aff77028c1c7d6101336f30f7a0c97ffb"><td class="mdescLeft"> </td><td class="mdescRight">The category name. <a href="#aff77028c1c7d6101336f30f7a0c97ffb">More...</a><br/></td></tr>
<tr class="separator:aff77028c1c7d6101336f30f7a0c97ffb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a940672ee38947e5dd9e12bb26adf4047"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4shib_1_1LoggingEvent.html#a940672ee38947e5dd9e12bb26adf4047">message</a></td></tr>
<tr class="memdesc:a940672ee38947e5dd9e12bb26adf4047"><td class="mdescLeft"> </td><td class="mdescRight">The application supplied message of logging event. <a href="#a940672ee38947e5dd9e12bb26adf4047">More...</a><br/></td></tr>
<tr class="separator:a940672ee38947e5dd9e12bb26adf4047"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1032fae7ecb3d056ba071060b317e015"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4shib_1_1LoggingEvent.html#a1032fae7ecb3d056ba071060b317e015">ndc</a></td></tr>
<tr class="memdesc:a1032fae7ecb3d056ba071060b317e015"><td class="mdescLeft"> </td><td class="mdescRight">The nested diagnostic context (<a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a>) of logging event. <a href="#a1032fae7ecb3d056ba071060b317e015">More...</a><br/></td></tr>
<tr class="separator:a1032fae7ecb3d056ba071060b317e015"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab86521694736c50214aa6621f0c491fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4shib_1_1LoggingEvent.html#ab86521694736c50214aa6621f0c491fd">priority</a></td></tr>
<tr class="memdesc:ab86521694736c50214aa6621f0c491fd"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classlog4shib_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages. ">Priority</a> of logging event. <a href="#ab86521694736c50214aa6621f0c491fd">More...</a><br/></td></tr>
<tr class="separator:ab86521694736c50214aa6621f0c491fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8205a2696c3929efb7294cf42b22786e"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4shib_1_1LoggingEvent.html#a8205a2696c3929efb7294cf42b22786e">threadName</a></td></tr>
<tr class="memdesc:a8205a2696c3929efb7294cf42b22786e"><td class="mdescLeft"> </td><td class="mdescRight">The name of thread in which this logging event was generated, e.g. <a href="#a8205a2696c3929efb7294cf42b22786e">More...</a><br/></td></tr>
<tr class="separator:a8205a2696c3929efb7294cf42b22786e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27759649719908b14b0ae6dcc32372cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4shib_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4shib_1_1LoggingEvent.html#a27759649719908b14b0ae6dcc32372cc">timeStamp</a></td></tr>
<tr class="memdesc:a27759649719908b14b0ae6dcc32372cc"><td class="mdescLeft"> </td><td class="mdescRight">The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created. <a href="#a27759649719908b14b0ae6dcc32372cc">More...</a><br/></td></tr>
<tr class="separator:a27759649719908b14b0ae6dcc32372cc"><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 internal representation of logging events. </p>
<p>When a affirmative logging decision is made a <code><a class="el" href="structlog4shib_1_1LoggingEvent.html" title="The internal representation of logging events. ">LoggingEvent</a></code> instance is created. This instance is passed around the different <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a> components.</p>
<p>This class is of concern to those wishing to extend <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a>. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="abd805b8da1feeed7ab4207179edca4d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4shib::LoggingEvent::LoggingEvent </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>ndc</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Instantiate a <a class="el" href="structlog4shib_1_1LoggingEvent.html" title="The internal representation of logging events. ">LoggingEvent</a> from the supplied parameters. </p>
<p>Except <code>timeStamp</code> all the other fields of <code><a class="el" href="structlog4shib_1_1LoggingEvent.html" title="The internal representation of logging events. ">LoggingEvent</a></code> are filled when actually needed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">category</td><td>The category of this event. </td></tr>
<tr><td class="paramname">message</td><td>The message of this event. </td></tr>
<tr><td class="paramname">ndc</td><td>The nested diagnostic context of this event. </td></tr>
<tr><td class="paramname">priority</td><td>The priority of this event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aff77028c1c7d6101336f30f7a0c97ffb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string log4shib::LoggingEvent::categoryName</td>
</tr>
</table>
</div><div class="memdoc">
<p>The category name. </p>
</div>
</div>
<a class="anchor" id="a940672ee38947e5dd9e12bb26adf4047"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string log4shib::LoggingEvent::message</td>
</tr>
</table>
</div><div class="memdoc">
<p>The application supplied message of logging event. </p>
</div>
</div>
<a class="anchor" id="a1032fae7ecb3d056ba071060b317e015"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string log4shib::LoggingEvent::ndc</td>
</tr>
</table>
</div><div class="memdoc">
<p>The nested diagnostic context (<a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a>) of logging event. </p>
</div>
</div>
<a class="anchor" id="ab86521694736c50214aa6621f0c491fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> log4shib::LoggingEvent::priority</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classlog4shib_1_1Priority.html" title="The Priority class provides importance levels with which one can categorize log messages. ">Priority</a> of logging event. </p>
</div>
</div>
<a class="anchor" id="a8205a2696c3929efb7294cf42b22786e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string log4shib::LoggingEvent::threadName</td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of thread in which this logging event was generated, e.g. </p>
<p>the PID. </p>
</div>
</div>
<a class="anchor" id="a27759649719908b14b0ae6dcc32372cc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4shib_1_1TimeStamp.html">TimeStamp</a> log4shib::LoggingEvent::timeStamp</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="LoggingEvent_8hh_source.html">LoggingEvent.hh</a></li>
<li><a class="el" href="LoggingEvent_8cpp.html">LoggingEvent.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>
