mirror of
https://github.com/thestk/stk
synced 2026-01-14 21:41:53 +00:00
Release 4.0 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
81475b04c5
commit
43dcd5775a
125
doc/html/classThread.html
Normal file
125
doc/html/classThread.html
Normal file
@@ -0,0 +1,125 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
|
||||
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
||||
</HEAD>
|
||||
<BODY BGCOLOR="#FFFFFF">
|
||||
<CENTER>
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"><P>
|
||||
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <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.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="Thread_8h-source.html">Thread.h</a>></code>
|
||||
<p>
|
||||
<p>Inheritance diagram for Thread::
|
||||
<p><center><img src="classThread.gif" usemap="#Thread_map" border="0"></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>
|
||||
</td><td valign=bottom><a class="el" href="classThread.html#a0">Thread</a> ()</td></tr>
|
||||
<tr><td> </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>
|
||||
</td><td valign=bottom><a class="el" href="classThread.html#a1">~Thread</a> ()</td></tr>
|
||||
<tr><td> </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 </td><td valign=bottom><a class="el" href="classThread.html#a2">start</a> (THREAD_FUNCTION routine, void *ptr=NULL)</td></tr>
|
||||
<tr><td> </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 </td><td valign=bottom><a class="el" href="classThread.html#a3">wait</a> (long milliseconds=-1)</td></tr>
|
||||
<tr><td> </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 </td><td valign=bottom><a class="el" href="classThread.html#d0">test</a> (void)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Test for a thread cancellation request.</em></font><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.
|
||||
<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">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td><b>
|
||||
void * <em>ptr</em> = NULL )
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
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">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<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 )
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
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>
|
||||
</table>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="Thread_8h-source.html">Thread.h</a></ul>
|
||||
<HR>
|
||||
|
||||
<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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
Reference in New Issue
Block a user