<!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>RAUL: Raul::Thread 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.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</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>
<div class="navpath">
<ul>
<li><b>Raul</b> </li>
<li><a class="el" href="classRaul_1_1Thread.html">Raul::Thread</a> </li>
</ul>
</div>
</div>
<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="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>Raul::Thread Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::Thread" -->
<p>Abstract base class for a thread.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Thread_8hpp_source.html">Thread.hpp</a>></code></p>
<p>Inherited by <a class="el" href="classRaul_1_1Slave.html">Raul::Slave</a>.</p>
<p><a href="classRaul_1_1Thread-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Thread.html#a0a028e2064416a518f883fe332e14ef5">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Launch and start the thread. <a href="#a0a028e2064416a518f883fe332e14ef5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Thread.html#a8f084f2013510a4a6da0a46acf2b51e9">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop and terminate the thread. <a href="#a8f084f2013510a4a6da0a46acf2b51e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87927da8fc7cb0344e311a13db1cf249"></a><!-- doxytag: member="Raul::Thread::set_scheduling" ref="a87927da8fc7cb0344e311a13db1cf249" args="(int policy, unsigned int priority)" -->
void </td><td class="memItemRight" valign="bottom"><b>set_scheduling</b> (int policy, unsigned int priority)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4bce7f832d7f8b5dfd583d5c9a349709"></a><!-- doxytag: member="Raul::Thread::name" ref="a4bce7f832d7f8b5dfd583d5c9a349709" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><b>name</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21453654cfdd49e1715857f9c7d68038"></a><!-- doxytag: member="Raul::Thread::set_name" ref="a21453654cfdd49e1715857f9c7d68038" args="(const std::string &name)" -->
void </td><td class="memItemRight" valign="bottom"><b>set_name</b> (const std::string &name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05323ac76aabeb5fc5a1b6ef127c156b"></a><!-- doxytag: member="Raul::Thread::is_context" ref="a05323ac76aabeb5fc5a1b6ef127c156b" args="(unsigned context) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>is_context</b> (unsigned context) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7c890a5395716d77aa3e79d137f69ce"></a><!-- doxytag: member="Raul::Thread::set_context" ref="af7c890a5395716d77aa3e79d137f69ce" args="(unsigned context)" -->
void </td><td class="memItemRight" valign="bottom"><b>set_context</b> (unsigned context)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7de46cc6f9d333a1dd802b59de898f1d"></a><!-- doxytag: member="Raul::Thread::create" ref="a7de46cc6f9d333a1dd802b59de898f1d" args="(const std::string &name="")" -->
static <a class="el" href="classRaul_1_1Thread.html">Thread</a> * </td><td class="memItemRight" valign="bottom"><b>create</b> (const std::string &name="")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98cdda2888321faf49b7b13ca0b427cc"></a><!-- doxytag: member="Raul::Thread::create_for_this_thread" ref="a98cdda2888321faf49b7b13ca0b427cc" args="(const std::string &name="")" -->
static <a class="el" href="classRaul_1_1Thread.html">Thread</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Thread.html#a98cdda2888321faf49b7b13ca0b427cc">create_for_this_thread</a> (const std::string &name="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Must be called from thread. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classRaul_1_1Thread.html">Thread</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Thread.html#adae09d79b1dabbc657f1fd4fc929bb1d">get</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the calling thread. <a href="#adae09d79b1dabbc657f1fd4fc929bb1d"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcf22c7bf2f36015ef673b7a5eb486fe"></a><!-- doxytag: member="Raul::Thread::Thread" ref="adcf22c7bf2f36015ef673b7a5eb486fe" args="(const std::string &name="")" -->
</td><td class="memItemRight" valign="bottom"><b>Thread</b> (const std::string &name="")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acea68dcde3b33907b13d94754fcc4325"></a><!-- doxytag: member="Raul::Thread::Thread" ref="acea68dcde3b33907b13d94754fcc4325" args="(pthread_t thread, const std::string &name="")" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Thread.html#acea68dcde3b33907b13d94754fcc4325">Thread</a> (pthread_t thread, const std::string &name="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Must be called from thread. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Thread.html#aab617edef1a42b980c67fe309f86b109">_run</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> function to execute. <a href="#aab617edef1a42b980c67fe309f86b109"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a460970a2dffcfd875d74312403b14ecd"></a><!-- doxytag: member="Raul::Thread::_exit_flag" ref="a460970a2dffcfd875d74312403b14ecd" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>_exit_flag</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Abstract base class for a thread. </p>
<p>Extend this and override the _run method to easily create a thread to perform some task.</p>
<p>The current <a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> can be accessed using the <a class="el" href="classRaul_1_1Thread.html#adae09d79b1dabbc657f1fd4fc929bb1d" title="Return the calling thread.">get()</a> method. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adae09d79b1dabbc657f1fd4fc929bb1d"></a><!-- doxytag: member="Raul::Thread::get" ref="adae09d79b1dabbc657f1fd4fc929bb1d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRaul_1_1Thread.html">Thread</a> & Raul::Thread::get </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the calling thread. </p>
<p>The return value of this should NOT be cached unless the thread is explicitly user created with create(). </p>
</div>
</div>
<a class="anchor" id="a0a028e2064416a518f883fe332e14ef5"></a><!-- doxytag: member="Raul::Thread::start" ref="a0a028e2064416a518f883fe332e14ef5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Raul::Thread::start </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Launch and start the thread. </p>
</div>
</div>
<a class="anchor" id="a8f084f2013510a4a6da0a46acf2b51e9"></a><!-- doxytag: member="Raul::Thread::stop" ref="a8f084f2013510a4a6da0a46acf2b51e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Raul::Thread::stop </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop and terminate the thread. </p>
</div>
</div>
<a class="anchor" id="aab617edef1a42b980c67fe309f86b109"></a><!-- doxytag: member="Raul::Thread::_run" ref="aab617edef1a42b980c67fe309f86b109" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Raul::Thread::_run </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> function to execute. </p>
<p>This is called once on start, and terminated on stop. Implementations likely want to put some infinite loop here.</p>
<p>When _exit_flag becomes true (via a call to <a class="el" href="classRaul_1_1Thread.html#a8f084f2013510a4a6da0a46acf2b51e9" title="Stop and terminate the thread.">stop()</a>) the loop should exit. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Thread_8hpp_source.html">Thread.hpp</a></li>
<li>Thread.cpp</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
174
