/usr/share/doc/libucommon-dev/a00058.html is in libucommon-doc 3.2.0-0ubuntu1.
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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 | <!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"/>
<title>UCommon: ucc::JoinableThread Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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 class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00058.html">JoinableThread</a>
</div>
</div>
<div class="contents">
<h1>ucc::JoinableThread Class Reference</h1><!-- doxytag: class="ucc::JoinableThread" --><!-- doxytag: inherits="ucc::Thread" -->
<p>A child thread object that may be joined by parent.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00208_source.html">thread.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::JoinableThread:</div>
<div class="dynsection">
<div class="center"><img src="a00398.png" border="0" usemap="#ucc_1_1_joinable_thread_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_joinable_thread_inherit__map" id="ucc_1_1_joinable_thread_inherit__map">
<area shape="rect" id="node2" href="a00166.html" title="An abstract class for defining classes that operate as a thread." alt="" coords="29,5,125,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::JoinableThread:</div>
<div class="dynsection">
<div class="center"><img src="a00399.png" border="0" usemap="#ucc_1_1_joinable_thread_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_joinable_thread_coll__map" id="ucc_1_1_joinable_thread_coll__map">
<area shape="rect" id="node2" href="a00166.html" title="An abstract class for defining classes that operate as a thread." alt="" coords="29,5,125,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a5cbed341323aebffcf73f5376ca0f14e">background</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start execution of child context as background thread. <a href="#a5cbed341323aebffcf73f5376ca0f14e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#aed88e32ff6369cc23a9ee00c7ef7485b">isRunning</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if thread is currently running. <a href="#aed88e32ff6369cc23a9ee00c7ef7485b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a6365bb6187c9e605aa1e38ed21fdb387">start</a> (int priority=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start execution of child context. <a href="#a6365bb6187c9e605aa1e38ed21fdb387"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a3516d614f105efa0f0ab62db2e6d136a">join</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Join thread with parent. <a href="#a3516d614f105efa0f0ab62db2e6d136a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a02fb5e28d950418cd6436967caa08a00">JoinableThread</a> (size_t size=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a joinable thread with a known context stack size. <a href="#a02fb5e28d950418cd6436967caa08a00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a6e78fd39dfe835e98198f0d11a7c955c">~JoinableThread</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete child thread. <a href="#a6e78fd39dfe835e98198f0d11a7c955c"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A child thread object that may be joined by parent. </p>
<p>A child thread is a type of thread in which the parent thread (or process main thread) can then wait for the child thread to complete and then delete the child object. The parent thread can wait for the child thread to complete either by calling join, or performing a "delete" of the derived child object. In either case the parent thread will suspend execution until the child thread exits. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01557">1557</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a02fb5e28d950418cd6436967caa08a00"></a><!-- doxytag: member="ucc::JoinableThread::JoinableThread" ref="a02fb5e28d950418cd6436967caa08a00" args="(size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::JoinableThread::JoinableThread </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em> = <code>0</code></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a joinable thread with a known context stack size. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of stack for thread context or 0 for default. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6e78fd39dfe835e98198f0d11a7c955c"></a><!-- doxytag: member="ucc::JoinableThread::~JoinableThread" ref="a6e78fd39dfe835e98198f0d11a7c955c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ucc::JoinableThread::~JoinableThread </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete child thread. </p>
<p>Parent thread suspends until child thread run method completes or child thread calls it's exit method. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5cbed341323aebffcf73f5376ca0f14e"></a><!-- doxytag: member="ucc::JoinableThread::background" ref="a5cbed341323aebffcf73f5376ca0f14e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::JoinableThread::background </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start execution of child context as background thread. </p>
<p>This is assumed to be off main thread, with a priority lowered by one. </p>
<p>Definition at line <a class="el" href="a00208_source.html#l01613">1613</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00058_a5cbed341323aebffcf73f5376ca0f14e_cgraph.png" border="0" usemap="#a00058_a5cbed341323aebffcf73f5376ca0f14e_cgraph_map" alt=""></div>
<map name="a00058_a5cbed341323aebffcf73f5376ca0f14e_cgraph_map" id="a00058_a5cbed341323aebffcf73f5376ca0f14e_cgraph">
<area shape="rect" id="node3" href="a00214.html#a190c5597b1e578ec9c7b85e0b6705e48" title="Convenience function to start a joinable thread." alt="" coords="283,5,365,35"/><area shape="rect" id="node5" href="a00058.html#a6365bb6187c9e605aa1e38ed21fdb387" title="Start execution of child context." alt="" coords="415,5,596,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aed88e32ff6369cc23a9ee00c7ef7485b"></a><!-- doxytag: member="ucc::JoinableThread::isRunning" ref="aed88e32ff6369cc23a9ee00c7ef7485b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::JoinableThread::isRunning </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if thread is currently running. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true while thread is running. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01595">1595</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3516d614f105efa0f0ab62db2e6d136a"></a><!-- doxytag: member="ucc::JoinableThread::join" ref="a3516d614f105efa0f0ab62db2e6d136a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::JoinableThread::join </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Join thread with parent. </p>
<p>Calling from a child thread to exit is now depreciated behavior and in the future will not be supported. Threads should always return through their <a class="el" href="a00166.html#af2141c3768106bd6335bddafdb240f8f" title="Abstract interface for thread context run method.">run()</a> method. </p>
</div>
</div>
<a class="anchor" id="a6365bb6187c9e605aa1e38ed21fdb387"></a><!-- doxytag: member="ucc::JoinableThread::start" ref="a6365bb6187c9e605aa1e38ed21fdb387" args="(int priority=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::JoinableThread::start </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>priority</em> = <code>0</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start execution of child context. </p>
<p>This must be called after the child object is created (perhaps with "new") and before it can be joined. This method actually begins the new thread context, which then calls the object's run method. Optionally raise the priority of the thread when it starts under realtime priority. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>of child thread. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00208_source.html">thread.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:30 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|