e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-14 13:31:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
doc/html/classThread.html
View File

@@ -5,63 +5,73 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>Thread Class Reference</h1>STK thread class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Thread Class Reference</h1>STK thread class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Thread_8h-source.html">Thread.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Thread::
<p><center><img src="classThread.gif" usemap="#Thread_map" border="0"></center>
<p>Inheritance diagram for Thread:
<p><center><img src="classThread.png" usemap="#Thread_map" border="0" alt=""></center>
<map name="Thread_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,52,24">
</map>
<a href="classThread-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="Thread::Thread"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classThread.html#a0">Thread</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Thread::~Thread"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classThread.html#a1">~Thread</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The class destructor waits indefinitely for the thread to end before returning.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classThread.html#a2">start</a> (THREAD_FUNCTION routine, void *ptr=NULL)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Begin execution of the thread <em>routine</em>. Upon success, TRUE is returned.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classThread.html#a3">wait</a> (long milliseconds=-1)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Wait the specified number of milliseconds for the thread to terminate. Return TRUE on success.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="d0" doxytag="Thread::test"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classThread.html#d0">test</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Test for a thread cancellation request.</em></font><br><br></td></tr>
<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><a class="anchor" name="a0" doxytag="Thread::Thread" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a0">Thread</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Thread::~Thread" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a1">~Thread</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The class destructor waits indefinitely for the thread to end before returning. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a2">start</a> (THREAD_FUNCTION routine, void *ptr=NULL)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Begin execution of the thread <em>routine</em>. Upon success, TRUE is returned. <a href="#a2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a3">wait</a> (long milliseconds=-1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wait the specified number of milliseconds for the thread to terminate. Return TRUE on success. <a href="#a3"></a><br><br></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="anchor" name="e0" doxytag="Thread::test" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#e0">test</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test for a thread cancellation request. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK thread class.
<p>
This class provides a uniform interface for cross-platform threads. On unix systems, the pthread library is used. Under Windows, the C runtime threadex functions are used.
STK thread class.
<p>
This class provides a uniform interface for cross-platform threads. On unix systems, the pthread library is used. Under Windows, the C runtime threadex functions are used.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="Thread::start"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<p>
Definition at line <a class="el" href="Thread_8h-source.html#l00040">40</a> of file <a class="el" href="Thread_8h-source.html">Thread.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="Thread::start" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool Thread::start (
</b></td>
<td valign="bottom"><b>
THREAD_FUNCTION <em>routine</em>,
</b></td>
<td class="md" nowrap valign="top"> bool Thread::start </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">THREAD_FUNCTION&nbsp;</td>
<td class="mdname" nowrap> <em>routine</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>void *&nbsp;</td>
<td class="mdname" nowrap> <em>ptr</em> = NULL</td>
</tr>
<tr>
<td></td>
<td><b>
void * <em>ptr</em> = NULL&nbsp;)
</b></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
@@ -76,23 +86,23 @@ void * <em>ptr</em> = NULL&nbsp;)
<td>
<p>
Begin execution of the thread <em>routine</em>. Upon success, TRUE is returned.
Begin execution of the thread <em>routine</em>. Upon success, TRUE is returned.
<p>
The thread routine can be passed an argument via <em>ptr</em>. If the thread cannot be created, the return value is FALSE. </td>
</tr>
</table>
<a name="a3" doxytag="Thread::wait"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="a3" doxytag="Thread::wait" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool Thread::wait (
</b></td>
<td valign="bottom"><b>
long <em>milliseconds</em> = -1&nbsp;)
</b></td>
<td class="md" nowrap valign="top"> bool Thread::wait </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">long&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>milliseconds</em> = -1 </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
@@ -107,7 +117,7 @@ long <em>milliseconds</em> = -1&nbsp;)
<td>
<p>
Wait the specified number of milliseconds for the thread to terminate. Return TRUE on success.
Wait the specified number of milliseconds for the thread to terminate. Return TRUE on success.
<p>
If the specified time value is negative, the function will block indefinitely. Otherwise, the function will block up to a maximum of the specified time. A return value of FALSE indicates the thread did not terminate within the specified time limit. </td>
</tr>
@@ -118,7 +128,7 @@ If the specified time value is negative, the function will block indefinitely. O
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>