<!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::CategoryStream 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_1CategoryStream.html">CategoryStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classlog4shib_1_1CategoryStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">log4shib::CategoryStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class enables streaming simple types and objects to a category.
<a href="classlog4shib_1_1CategoryStream.html#details">More...</a></p>
<p><code>#include <<a class="el" href="CategoryStream_8hh_source.html">CategoryStream.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:a0db76a6cef4fad4707a121824e966a4a"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> &(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1CategoryStream.html#a0db76a6cef4fad4707a121824e966a4a">cspf</a> )(<a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> &)</td></tr>
<tr class="separator:a0db76a6cef4fad4707a121824e966a4a"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:ac07982d852d078dd6e26747fd674b373"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1CategoryStream.html#ac07982d852d078dd6e26747fd674b373">CategoryStream</a> (<a class="el" href="classlog4shib_1_1Category.html">Category</a> &category, <a class="el" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> priority)</td></tr>
<tr class="memdesc:ac07982d852d078dd6e26747fd674b373"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classlog4shib_1_1CategoryStream.html" title="This class enables streaming simple types and objects to a category. ">CategoryStream</a> for given <a class="el" href="classlog4shib_1_1Category.html" title="This is the central class in the log4j package. ">Category</a> with given priority. <a href="#ac07982d852d078dd6e26747fd674b373">More...</a><br /></td></tr>
<tr class="separator:ac07982d852d078dd6e26747fd674b373"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a552a0de57c40a32edae3226dde2b14c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1CategoryStream.html#a552a0de57c40a32edae3226dde2b14c8">~CategoryStream</a> ()</td></tr>
<tr class="memdesc:a552a0de57c40a32edae3226dde2b14c8"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classlog4shib_1_1CategoryStream.html" title="This class enables streaming simple types and objects to a category. ">CategoryStream</a>. <a href="#a552a0de57c40a32edae3226dde2b14c8">More...</a><br /></td></tr>
<tr class="separator:a552a0de57c40a32edae3226dde2b14c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8862d482f140bc5cd6a7017f6cb84e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4shib_1_1Category.html">Category</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1CategoryStream.html#ad8862d482f140bc5cd6a7017f6cb84e0">getCategory</a> () const </td></tr>
<tr class="memdesc:ad8862d482f140bc5cd6a7017f6cb84e0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the destination <a class="el" href="classlog4shib_1_1Category.html" title="This is the central class in the log4j package. ">Category</a> for this stream. <a href="#ad8862d482f140bc5cd6a7017f6cb84e0">More...</a><br /></td></tr>
<tr class="separator:ad8862d482f140bc5cd6a7017f6cb84e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ae4c69924ae190a26faed2e1a4ac673"><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="classlog4shib_1_1CategoryStream.html#a5ae4c69924ae190a26faed2e1a4ac673">getPriority</a> () const throw ()</td></tr>
<tr class="memdesc:a5ae4c69924ae190a26faed2e1a4ac673"><td class="mdescLeft"> </td><td class="mdescRight">Returns the priority for this stream. <a href="#a5ae4c69924ae190a26faed2e1a4ac673">More...</a><br /></td></tr>
<tr class="separator:a5ae4c69924ae190a26faed2e1a4ac673"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08982e057acfdbf84bb5abba9aeefa94"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1CategoryStream.html#a08982e057acfdbf84bb5abba9aeefa94">flush</a> ()</td></tr>
<tr class="memdesc:a08982e057acfdbf84bb5abba9aeefa94"><td class="mdescLeft"> </td><td class="mdescRight">Flush the contents of the stream buffer to the <a class="el" href="classlog4shib_1_1Category.html" title="This is the central class in the log4j package. ">Category</a> and empties the buffer. <a href="#a08982e057acfdbf84bb5abba9aeefa94">More...</a><br /></td></tr>
<tr class="separator:a08982e057acfdbf84bb5abba9aeefa94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc16b8d574bbf2b7ebad9274095fda7f"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:adc16b8d574bbf2b7ebad9274095fda7f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1CategoryStream.html#adc16b8d574bbf2b7ebad9274095fda7f">operator<<</a> (const T &t)</td></tr>
<tr class="memdesc:adc16b8d574bbf2b7ebad9274095fda7f"><td class="mdescLeft"> </td><td class="mdescRight">Stream in arbitrary types and objects. <a href="#adc16b8d574bbf2b7ebad9274095fda7f">More...</a><br /></td></tr>
<tr class="separator:adc16b8d574bbf2b7ebad9274095fda7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af482d7c3a045ee16e3b7f14d572fda14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1CategoryStream.html#af482d7c3a045ee16e3b7f14d572fda14">operator<<</a> (<a class="el" href="classlog4shib_1_1CategoryStream.html#a0db76a6cef4fad4707a121824e966a4a">cspf</a>)</td></tr>
<tr class="separator:af482d7c3a045ee16e3b7f14d572fda14"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:af42b8577c7d5357f9a70f8f1be623451"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a> friend <br class="typebreak" />
<a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1CategoryStream.html#af42b8577c7d5357f9a70f8f1be623451">eol</a> (<a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> &os)</td></tr>
<tr class="memdesc:af42b8577c7d5357f9a70f8f1be623451"><td class="mdescLeft"> </td><td class="mdescRight">eol manipulator <a href="#af42b8577c7d5357f9a70f8f1be623451">More...</a><br /></td></tr>
<tr class="separator:af42b8577c7d5357f9a70f8f1be623451"><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 enables streaming simple types and objects to a category. </p>
<p>Use category.errorStream(), etc. to obtain a <a class="el" href="classlog4shib_1_1CategoryStream.html" title="This class enables streaming simple types and objects to a category. ">CategoryStream</a> class. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a0db76a6cef4fad4707a121824e966a4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a>&(* log4shib::CategoryStream::cspf)(<a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> &)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac07982d852d078dd6e26747fd674b373"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4shib::CategoryStream::CategoryStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4shib_1_1Category.html">Category</a> & </td>
<td class="paramname"><em>category</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>Construct a <a class="el" href="classlog4shib_1_1CategoryStream.html" title="This class enables streaming simple types and objects to a category. ">CategoryStream</a> for given <a class="el" href="classlog4shib_1_1Category.html" title="This is the central class in the log4j package. ">Category</a> with given priority. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">category</td><td>The category this stream will send log messages to. </td></tr>
<tr><td class="paramname">priority</td><td>The priority the log messages will get or <a class="el" href="classlog4shib_1_1Priority.html#a0c93eada3fec209680988abdde4230e7a5cf392e9207ff6e9beb7293e0bc0df00">Priority::NOTSET</a> to silently discard any streamed in messages. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a552a0de57c40a32edae3226dde2b14c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4shib::CategoryStream::~CategoryStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor for <a class="el" href="classlog4shib_1_1CategoryStream.html" title="This class enables streaming simple types and objects to a category. ">CategoryStream</a>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a08982e057acfdbf84bb5abba9aeefa94"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void log4shib::CategoryStream::flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush the contents of the stream buffer to the <a class="el" href="classlog4shib_1_1Category.html" title="This is the central class in the log4j package. ">Category</a> and empties the buffer. </p>
</div>
</div>
<a class="anchor" id="ad8862d482f140bc5cd6a7017f6cb84e0"></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_1Category.html">Category</a>& log4shib::CategoryStream::getCategory </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>Returns the destination <a class="el" href="classlog4shib_1_1Category.html" title="This is the central class in the log4j package. ">Category</a> for this stream. </p>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="classlog4shib_1_1Category.html" title="This is the central class in the log4j package. ">Category</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a5ae4c69924ae190a26faed2e1a4ac673"></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::CategoryStream::getPriority </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the priority for this stream. </p>
<dl class="section return"><dt>Returns</dt><dd>The priority. </dd></dl>
</div>
</div>
<a class="anchor" id="adc16b8d574bbf2b7ebad9274095fda7f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a>& log4shib::CategoryStream::operator<< </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></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>Stream in arbitrary types and objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td>The value or object to stream in. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to itself. </dd></dl>
</div>
</div>
<a class="anchor" id="af482d7c3a045ee16e3b7f14d572fda14"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> & log4shib::CategoryStream::operator<< </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4shib_1_1CategoryStream.html#a0db76a6cef4fad4707a121824e966a4a">cspf</a> </td>
<td class="paramname"><em>pf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="af42b8577c7d5357f9a70f8f1be623451"></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="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a> friend <a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a>& eol </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4shib_1_1CategoryStream.html">CategoryStream</a> & </td>
<td class="paramname"><em>os</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>eol manipulator </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="CategoryStream_8hh_source.html">CategoryStream.hh</a></li>
<li><a class="el" href="CategoryStream_8cpp.html">CategoryStream.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
>
202
