mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
Release 4.2.0 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
fe20fe92a2
commit
de344668dd
@@ -9,17 +9,25 @@
|
||||
<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="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.3.4 -->
|
||||
<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>
|
||||
<h1>Thread Class Reference</h1><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.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>
|
||||
<a href="classThread-members.html">List of all members.</a><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>
|
||||
Each instance of the Thread class can be used to control a single thread process. Routines are provided to signal cancelation and/or joining with a thread, though it is not possible for this class to know the running status of a thread once it is started.<p>
|
||||
For cross-platform compatability, thread functions should be declared as follows:<p>
|
||||
THREAD_RETURN THREAD_TYPE thread_function(void *ptr)<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
||||
<p>
|
||||
|
||||
<p>
|
||||
Definition at line <a class="el" href="Thread_8h-source.html#l00047">47</a> of file <a class="el" href="Thread_8h-source.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><a class="anchor" name="a0" doxytag="Thread::Thread" ></a>
|
||||
@@ -29,28 +37,21 @@
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Thread::~Thread" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a1">~Thread</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The class destructor waits indefinitely for the thread to end before returning. <br><br></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The class destructor does not attempt to cancel or join a thread. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </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"> </td><td class="mdescRight">Begin execution of the thread <em>routine</em>. Upon success, TRUE is returned. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a3">wait</a> (long milliseconds=-1)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin execution of the thread <em>routine</em>. Upon success, true is returned. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a3">cancel</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait the specified number of milliseconds for the thread to terminate. Return TRUE on success. </em> <a href="#a3"></a><em><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 </td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#e0">test</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal cancellation of a thread routine, returning <em>true</em> on success. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a4">wait</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test for a thread cancellation request. <br><br></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Block the calling routine indefinitely until the thread terminates. </em> <a href="#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classThread.html#a5">testCancel</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a cancellation point within a thread routine. </em> <a href="#a5"></a><em><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>
|
||||
|
||||
<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>
|
||||
<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>
|
||||
@@ -86,21 +87,21 @@ Definition at line <a class="el" href="Thread_8h-source.html#l00040">40</a> of f
|
||||
<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>
|
||||
A data pointer can be supplied to the thread routine via the optional <em>ptr</em> argument. If the thread cannot be created, the return value is false. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="Thread::wait" ></a><p>
|
||||
<a class="anchor" name="a3" doxytag="Thread::cancel" ></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"> bool Thread::wait </td>
|
||||
<td class="md" nowrap valign="top"> bool Thread::cancel </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">long </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>milliseconds</em> = -1 </td>
|
||||
<td class="md" nowrap valign="top">void </td>
|
||||
<td class="mdname1" valign="top" nowrap> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
@@ -117,9 +118,71 @@ The thread routine can be passed an argument via <em>ptr</em>. If the thread can
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Wait the specified number of milliseconds for the thread to terminate. Return TRUE on success.
|
||||
Signal cancellation of a thread routine, returning <em>true</em> 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>
|
||||
This function only signals thread cancellation. It does not wait to verify actual routine termination. A <em>true</em> return value only signifies that the cancellation signal was properly executed, not thread cancellation. A thread routine may need to make use of the <a class="el" href="classThread.html#a5">testCancel()</a> function to specify a cancellation point. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a4" doxytag="Thread::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"> bool Thread::wait </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">void </td>
|
||||
<td class="mdname1" valign="top" nowrap> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Block the calling routine indefinitely until the thread terminates.
|
||||
<p>
|
||||
This function suspends execution of the calling routine until the thread has terminated. It will return immediately if the thread was already terminated. A <em>true</em> return value signifies successful termination. A <em>false</em> return value indicates a problem with the wait call. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="Thread::testCancel" ></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"> void Thread::testCancel </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">void </td>
|
||||
<td class="mdname1" valign="top" nowrap> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Create a cancellation point within a thread routine.
|
||||
<p>
|
||||
This function call checks for thread cancellation, allowing the thread to be terminated if a cancellation request was previously signaled. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
@@ -127,7 +190,7 @@ If the specified time value is negative, the function will block indefinitely. O
|
||||
<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><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user