diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a03880.html | 353 |
1 files changed, 353 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03880.html b/docs/doxygen/nel/a03880.html new file mode 100644 index 00000000..51a4ebcb --- /dev/null +++ b/docs/doxygen/nel/a03880.html @@ -0,0 +1,353 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLMISC::IThread class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLMISC::IThread Class Reference</h1><code>#include <<a class="el" href="a06535.html">thread.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Thread base interface, must be implemented for all OS <dl compact><dt><b>Author:</b></dt><dd>Vianney Lecroart <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2000 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06535.html#l00086">86</a> of file <a class="el" href="a06535.html">thread.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a13">uint64</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreada0">getCPUMask</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a02187.html">IRunnable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreada1">getRunnable</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the runnable object. <a href="#NLMISC_1_1IThreada1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreada2">getUserName</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreada3">setCPUMask</a> (<a class="el" href="a04558.html#a13">uint64</a> cpuMask)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreada4">start</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreada5">terminate</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreada6">wait</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreada7">~IThread</a> ()</td></tr> + +<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03880.html">IThread</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreade0">create</a> (<a class="el" href="a02187.html">IRunnable</a> *runnable)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03880.html">IThread</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03880.html#NLMISC_1_1IThreade1">getCurrentThread</a> ()</td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLMISC_1_1IThreada7" doxytag="NLMISC::IThread::~IThread" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual NLMISC::IThread::~<a class="el" href="a03880.html">IThread</a> </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06535.html#l00103">103</a> of file <a class="el" href="a06535.html">thread.h</a>. +<p> +<div class="fragment"><pre>00103 { } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLMISC_1_1IThreade0" doxytag="NLMISC::IThread::create" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03880.html">IThread</a>* NLMISC::IThread::create </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02187.html">IRunnable</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>runnable</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a new thread. Implemented in the derived class. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IThreada0" doxytag="NLMISC::IThread::getCPUMask" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="a04558.html#a13">uint64</a> NLMISC::IThread::getCPUMask </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the CPU mask of this thread. Thread must have been started before. The mask should be a subset of the CPU mask returned by <a class="el" href="a03872.html#NLMISC_1_1IProcessa0">IProcess::getCPUMask()</a> thread process. Not implemented under Linux. +<p> +Referenced by <a class="el" href="a06768.html#l00920">NL3D::CZoneLighter::light()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IThreade1" doxytag="NLMISC::IThread::getCurrentThread" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03880.html">IThread</a>* NLMISC::IThread::getCurrentThread </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a pointer on the current thread. Implemented in the derived class. Not implemented under Linux. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IThreada1" doxytag="NLMISC::IThread::getRunnable" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="a02187.html">IRunnable</a>* NLMISC::IThread::getRunnable </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a pointer to the runnable object. +<p> + +<p> +Referenced by <a class="el" href="a05512.html#l00166">NLNET::CBufServer::~CBufServer()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IThreada2" doxytag="NLMISC::IThread::getUserName" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual std::string NLMISC::IThread::getUserName </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the thread user name. Notimplemented under linux, under windows return the name of the logon user. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IThreada3" doxytag="NLMISC::IThread::setCPUMask" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLMISC::IThread::setCPUMask </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a13">uint64</a> </td> + <td class="mdname1" valign="top" nowrap> <em>cpuMask</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the CPU mask of this thread. Thread must have been started before. The mask must be a subset of the CPU mask returned by <a class="el" href="a03872.html#NLMISC_1_1IProcessa0">IProcess::getCPUMask()</a> thread process. Not implemented under Linux. +<p> +Referenced by <a class="el" href="a06768.html#l00920">NL3D::CZoneLighter::light()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IThreada4" doxytag="NLMISC::IThread::start" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IThread::start </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Referenced by <a class="el" href="a05506.html#l00085">NLNET::CBufClient::connect()</a>, <a class="el" href="a06751.html#l00120">NLMISC::CWindowDisplayer::create()</a>, <a class="el" href="a06485.html#l00039">NLMISC::CTaskManager::CTaskManager()</a>, <a class="el" href="a05512.html#l00093">NLNET::CBufServer::init()</a>, <a class="el" href="a06768.html#l00920">NL3D::CZoneLighter::light()</a>, and <a class="el" href="a06768.html#l02800">NL3D::CZoneLighter::lightShapes()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IThreada5" doxytag="NLMISC::IThread::terminate" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IThread::terminate </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IThreada6" doxytag="NLMISC::IThread::wait" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IThread::wait </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Referenced by <a class="el" href="a05506.html#l00397">NLNET::CBufClient::~CBufClient()</a>, <a class="el" href="a05512.html#l00166">NLNET::CBufServer::~CBufServer()</a>, and <a class="el" href="a06751.html#l00068">NLMISC::CWindowDisplayer::~CWindowDisplayer()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06535.html">thread.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:48:19 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |