<!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: ucommon::DetachedThread 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="a00208.html">ucommon</a>::<a class="el" href="a00045.html">DetachedThread</a>
</div>
</div>
<div class="contents">
<h1>ucommon::DetachedThread Class Reference</h1><!-- doxytag: class="ucommon::DetachedThread" --><!-- doxytag: inherits="ucommon::Thread" -->
<p>A detached thread object that is stand-alone.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00202_source.html">thread.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::DetachedThread:</div>
<div class="dynsection">
<div class="center"><img src="a00375.png" border="0" usemap="#ucommon_1_1_detached_thread_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_detached_thread_inherit__map" id="ucommon_1_1_detached_thread_inherit__map">
<area shape="rect" id="node2" href="a00156.html" title="An abstract class for defining classes that operate as a thread." alt="" coords="45,5,216,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::DetachedThread:</div>
<div class="dynsection">
<div class="center"><img src="a00376.png" border="0" usemap="#ucommon_1_1_detached_thread_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_detached_thread_coll__map" id="ucommon_1_1_detached_thread_coll__map">
<area shape="rect" id="node2" href="a00156.html" title="An abstract class for defining classes that operate as a thread." alt="" coords="45,5,216,32"/></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"><a class="anchor" id="af9fdc6d3d2a2c6d508e0461c6958eed2"></a><!-- doxytag: member="ucommon::DetachedThread::isRunning" ref="af9fdc6d3d2a2c6d508e0461c6958eed2" args="(void)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#af9fdc6d3d2a2c6d508e0461c6958eed2">isRunning</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if running. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a55bee7740e411af3dcf6cc9472813e9e">start</a> (int priority=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start execution of detached context. <a href="#a55bee7740e411af3dcf6cc9472813e9e"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#aefc806a422d5e5022740e07e71b02fc3">DetachedThread</a> (size_t size=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a detached thread with a known context stack size. <a href="#aefc806a422d5e5022740e07e71b02fc3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a0882735cc31db5b46e15ccfe864b96a6">exit</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exit context of detached thread. <a href="#a0882735cc31db5b46e15ccfe864b96a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a13f566617b5db546f69dd280a12ebb4d">~DetachedThread</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys object when thread context exits. <a href="#a13f566617b5db546f69dd280a12ebb4d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74f0ed49402d8775b8264aa865111d69"></a><!-- doxytag: member="ucommon::DetachedThread::active" ref="a74f0ed49402d8775b8264aa865111d69" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>active</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A detached thread object that is stand-alone. </p>
<p>This object has no relationship with any other running thread instance will be automatically deleted when the running thread instance exits, either by it's run method exiting, or explicity calling the exit member function. </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="a00202_source.html#l01670">1670</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aefc806a422d5e5022740e07e71b02fc3"></a><!-- doxytag: member="ucommon::DetachedThread::DetachedThread" ref="aefc806a422d5e5022740e07e71b02fc3" args="(size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::DetachedThread::DetachedThread </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 detached 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="a13f566617b5db546f69dd280a12ebb4d"></a><!-- doxytag: member="ucommon::DetachedThread::~DetachedThread" ref="a13f566617b5db546f69dd280a12ebb4d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::DetachedThread::~DetachedThread </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys object when thread context exits. </p>
<p>Never externally deleted. Derived object may also have destructor to clean up thread-specific member data. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0882735cc31db5b46e15ccfe864b96a6"></a><!-- doxytag: member="ucommon::DetachedThread::exit" ref="a0882735cc31db5b46e15ccfe864b96a6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::DetachedThread::exit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Exit context of detached thread. </p>
<p><a class="el" href="a00156.html" title="An abstract class for defining classes that operate as a thread.">Thread</a> object will be deleted. This function should NO LONGER be called directly to exit a running thread. Instead, the thread should only "return" through the <a class="el" href="a00156.html#a6a772f1389024571722dfc4b400c175b" title="Abstract interface for thread context run method.">run()</a> method to exit. The documented usage was changed so that <a class="el" href="a00045.html#a0882735cc31db5b46e15ccfe864b96a6" title="Exit context of detached thread.">exit()</a> can still be used to modify the "delete this" behavior of detached threads while merging thread exit behavior with Mozilla NSPR. </p>
<p>Reimplemented from <a class="el" href="a00156.html#a6673eee6bba2a045f78bb12774bf52e9">ucommon::Thread</a>.</p>
</div>
</div>
<a class="anchor" id="a55bee7740e411af3dcf6cc9472813e9e"></a><!-- doxytag: member="ucommon::DetachedThread::start" ref="a55bee7740e411af3dcf6cc9472813e9e" args="(int priority=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::DetachedThread::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 detached context. </p>
<p>This must be called after the object is created (perhaps with "new"). This method actually begins the new thread context, which then calls the object's run method. </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>to start thread with. </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="a00202_source.html">thread.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:34 2011 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>
