/usr/share/doc/mia-2.0/libdoc/classCThreadMsgStream.html is in libmia-2.0-doc 2.0.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | <!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.6"/>
<title>CThreadMsgStream 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="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">CThreadMsgStream Class Reference<div class="ingroups"><a class="el" href="group__logging.html">Logging and debugguing</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>This class is used to handle syncronizized output of logging output in a multi-threaded environment.
<a href="classCThreadMsgStream.html#details">More...</a></p>
<p><code>#include <<a class="el" href="threadedmsg_8hh_source.html">mia/core/threadedmsg.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for CThreadMsgStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classCThreadMsgStream.png" usemap="#CThreadMsgStream_map" alt=""/>
<map id="CThreadMsgStream_map" name="CThreadMsgStream_map">
</map>
</div></div>
<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:a515d9a4300941ad0498161d4c79bbfc2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCThreadMsgStream.html#a515d9a4300941ad0498161d4c79bbfc2">CThreadMsgStream</a> ()</td></tr>
<tr class="separator:a515d9a4300941ad0498161d4c79bbfc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9305e7e5f0904a5009b54de434b35ae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCThreadMsgStream.html#aa9305e7e5f0904a5009b54de434b35ae">~CThreadMsgStream</a> ()</td></tr>
<tr class="separator:aa9305e7e5f0904a5009b54de434b35ae"><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:a0cd7505a6713c428b31cb08825a27d73"><td class="memTemplParams" colspan="2">template<typename OS > </td></tr>
<tr class="memitem:a0cd7505a6713c428b31cb08825a27d73"><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCThreadMsgStream.html#a0cd7505a6713c428b31cb08825a27d73">set_master_stream</a> (OS &master)</td></tr>
<tr class="separator:a0cd7505a6713c428b31cb08825a27d73"><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:af557f64981a52eb6f7cdae988434b246"><td class="memTemplParams" colspan="2">template<typename OS , typename placeholder > </td></tr>
<tr class="memitem:af557f64981a52eb6f7cdae988434b246"><td class="memTemplItemLeft" align="right" valign="top">struct </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCThreadMsgStream.html#af557f64981a52eb6f7cdae988434b246">__dispatch_set_master_stream</a></td></tr>
<tr class="separator:af557f64981a52eb6f7cdae988434b246"><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 is used to handle syncronizized output of logging output in a multi-threaded environment. </p>
<p>This class is used to syncronize the output of the logging stream cverb and its helper functions <a class="el" href="group__logging.html#ga18db913014fe0e9e951254c561074fca" title="send messages to this stream adapter ">cvmsg()</a>, <a class="el" href="group__logging.html#ga12a6d8ee415d5852065985b08ae39439" title="Short for debug output in non-debug build output send to this will be ignored. ">cvdebug()</a>, cverror(), cvwarning() ...</p>
<p>To use it, just declare a variable of type <a class="el" href="classCThreadMsgStream.html" title="This class is used to handle syncronizized output of logging output in a multi-threaded environment...">CThreadMsgStream</a> at the beginning of the threaded function. Output is only written to the master output stream if a newline is sent or explicit syncronization via flush() is requested.</p>
<p>Note, that a <a class="el" href="classCThreadMsgStream.html" title="This class is used to handle syncronizized output of logging output in a multi-threaded environment...">CThreadMsgStream</a> itself can not serve as master stream since it would deadlock. </p>
<p>Definition at line <a class="el" href="threadedmsg_8hh_source.html#l00044">44</a> of file <a class="el" href="threadedmsg_8hh_source.html">threadedmsg.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a515d9a4300941ad0498161d4c79bbfc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CThreadMsgStream::CThreadMsgStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. This constructor sets the thread-local output of the vstream backend to itself and saves to old output. </p>
</div>
</div>
<a class="anchor" id="aa9305e7e5f0904a5009b54de434b35ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CThreadMsgStream::~CThreadMsgStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. This destructor flushes the output and then resets the thread-local vstream backend to the original output. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0cd7505a6713c428b31cb08825a27d73"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename OS > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CThreadMsgStream::set_master_stream </td>
<td>(</td>
<td class="paramtype">OS & </td>
<td class="paramname"><em>master</em></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>Set the master output stream. The default is std::cerr. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">master</td><td>the new master output stream; </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>if the new master is of type <a class="el" href="classCThreadMsgStream.html" title="This class is used to handle syncronizized output of logging output in a multi-threaded environment...">CThreadMsgStream</a> a deadlock is certain. </dd></dl>
<p>Definition at line <a class="el" href="threadedmsg_8hh_source.html#l00108">108</a> of file <a class="el" href="threadedmsg_8hh_source.html">threadedmsg.hh</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="af557f64981a52eb6f7cdae988434b246"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename OS , typename placeholder > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend struct __dispatch_set_master_stream</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>Definition at line <a class="el" href="threadedmsg_8hh_source.html#l00066">66</a> of file <a class="el" href="threadedmsg_8hh_source.html">threadedmsg.hh</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="threadedmsg_8hh_source.html">threadedmsg.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:09 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|