mirror of
https://github.com/thestk/stk
synced 2026-01-14 13:31:53 +00:00
Release 4.4.0 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
3706458166
commit
d2ed001eb5
@@ -8,67 +8,73 @@
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.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="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.4.4 -->
|
||||
<div class="nav">
|
||||
<a class="el" href="dir_000000.html">include</a></div>
|
||||
<h1>Thread.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***************************************************/</span>
|
||||
<a name="l00021"></a>00021 <span class="comment">/***************************************************/</span>
|
||||
<!-- Generated by Doxygen 1.5.8 -->
|
||||
<div class="navpath"><a class="el" href="dir_d499f4756a454d8a02faa5ebe57d576f.html">include</a>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<h1>Thread.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_THREAD_H</span>
|
||||
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_THREAD_H</span>
|
||||
<a name="l00003"></a>00003 <span class="preprocessor"></span>
|
||||
<a name="l00004"></a>00004 <span class="preprocessor">#include "Stk.h"</span>
|
||||
<a name="l00005"></a>00005
|
||||
<a name="l00006"></a>00006 <span class="preprocessor">#if (defined(__OS_IRIX__) || defined(__OS_LINUX__) || defined(__OS_MACOSX__))</span>
|
||||
<a name="l00007"></a>00007 <span class="preprocessor"></span>
|
||||
<a name="l00008"></a>00008 <span class="preprocessor"> #include <pthread.h></span>
|
||||
<a name="l00009"></a>00009 <span class="preprocessor"> #define THREAD_TYPE</span>
|
||||
<a name="l00010"></a>00010 <span class="preprocessor"></span> <span class="keyword">typedef</span> pthread_t THREAD_HANDLE;
|
||||
<a name="l00011"></a>00011 <span class="keyword">typedef</span> <span class="keywordtype">void</span> * THREAD_RETURN;
|
||||
<a name="l00012"></a>00012 <span class="keyword">typedef</span> <span class="keywordtype">void</span> * (*THREAD_FUNCTION)(<span class="keywordtype">void</span> *);
|
||||
<a name="l00013"></a>00013
|
||||
<a name="l00014"></a>00014 <span class="preprocessor">#elif defined(__OS_WINDOWS__)</span>
|
||||
<a name="l00015"></a>00015 <span class="preprocessor"></span>
|
||||
<a name="l00016"></a>00016 <span class="preprocessor"> #include <windows.h></span>
|
||||
<a name="l00017"></a>00017 <span class="preprocessor"> #include <process.h></span>
|
||||
<a name="l00018"></a>00018 <span class="preprocessor"> #define THREAD_TYPE __stdcall</span>
|
||||
<a name="l00019"></a>00019 <span class="preprocessor"></span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> THREAD_HANDLE;
|
||||
<a name="l00020"></a>00020 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> THREAD_RETURN;
|
||||
<a name="l00021"></a>00021 <span class="keyword">typedef</span> unsigned (__stdcall *THREAD_FUNCTION)(<span class="keywordtype">void</span> *);
|
||||
<a name="l00022"></a>00022
|
||||
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef STK_THREAD_H</span>
|
||||
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define STK_THREAD_H</span>
|
||||
<a name="l00025"></a>00025 <span class="preprocessor"></span>
|
||||
<a name="l00026"></a>00026 <span class="preprocessor">#include "Stk.h"</span>
|
||||
<a name="l00027"></a>00027
|
||||
<a name="l00028"></a>00028 <span class="preprocessor">#if (defined(__OS_IRIX__) || defined(__OS_LINUX__) || defined(__OS_MACOSX__))</span>
|
||||
<a name="l00029"></a>00029 <span class="preprocessor"></span>
|
||||
<a name="l00030"></a>00030 <span class="preprocessor"> #include <pthread.h></span>
|
||||
<a name="l00031"></a>00031 <span class="preprocessor"> #define THREAD_TYPE</span>
|
||||
<a name="l00032"></a>00032 <span class="preprocessor"></span> <span class="keyword">typedef</span> pthread_t THREAD_HANDLE;
|
||||
<a name="l00033"></a>00033 <span class="keyword">typedef</span> <span class="keywordtype">void</span> * THREAD_RETURN;
|
||||
<a name="l00034"></a>00034 <span class="keyword">typedef</span> <span class="keywordtype">void</span> * (*THREAD_FUNCTION)(<span class="keywordtype">void</span> *);
|
||||
<a name="l00035"></a>00035
|
||||
<a name="l00036"></a>00036 <span class="preprocessor">#elif defined(__OS_WINDOWS__)</span>
|
||||
<a name="l00037"></a>00037 <span class="preprocessor"></span>
|
||||
<a name="l00038"></a>00038 <span class="preprocessor"> #include <windows.h></span>
|
||||
<a name="l00039"></a>00039 <span class="preprocessor"> #include <process.h></span>
|
||||
<a name="l00040"></a>00040 <span class="preprocessor"> #define THREAD_TYPE __stdcall</span>
|
||||
<a name="l00041"></a>00041 <span class="preprocessor"></span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> THREAD_HANDLE;
|
||||
<a name="l00042"></a>00042 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> THREAD_RETURN;
|
||||
<a name="l00043"></a>00043 <span class="keyword">typedef</span> unsigned (__stdcall *THREAD_FUNCTION)(<span class="keywordtype">void</span> *);
|
||||
<a name="l00044"></a>00044
|
||||
<a name="l00045"></a>00045 <span class="preprocessor">#endif</span>
|
||||
<a name="l00046"></a>00046 <span class="preprocessor"></span>
|
||||
<a name="l00047"></a><a class="code" href="classThread.html">00047</a> <span class="keyword">class </span><a class="code" href="classThread.html">Thread</a> : <span class="keyword">public</span> <a class="code" href="classStk.html">Stk</a>
|
||||
<a name="l00048"></a>00048 {
|
||||
<a name="l00049"></a>00049 <span class="keyword">public</span>:
|
||||
<a name="l00051"></a>00051 <a class="code" href="classThread.html#a0">Thread</a>();
|
||||
<a name="l00052"></a>00052
|
||||
<a name="l00054"></a>00054 <a class="code" href="classThread.html#a1">~Thread</a>();
|
||||
<a name="l00055"></a>00055
|
||||
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
|
||||
<a name="l00024"></a>00024 <span class="preprocessor"></span>
|
||||
<a name="l00025"></a>00025 <span class="keyword">namespace </span>stk {
|
||||
<a name="l00026"></a>00026
|
||||
<a name="l00027"></a>00027 <span class="comment">/***************************************************/</span>
|
||||
<a name="l00047"></a>00047 <span class="comment">/***************************************************/</span>
|
||||
<a name="l00048"></a>00048
|
||||
<a name="l00049"></a><a class="code" href="classstk_1_1Thread.html">00049</a> <span class="keyword">class </span><a class="code" href="classstk_1_1Thread.html" title="STK thread class.">Thread</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Stk.html" title="STK base class.">Stk</a>
|
||||
<a name="l00050"></a>00050 {
|
||||
<a name="l00051"></a>00051 <span class="keyword">public</span>:
|
||||
<a name="l00053"></a>00053 <a class="code" href="classstk_1_1Thread.html#550db7efe16cd4ef223d9ca69dda384b" title="Default constructor.">Thread</a>();
|
||||
<a name="l00054"></a>00054
|
||||
<a name="l00056"></a>00056 <a class="code" href="classstk_1_1Thread.html#f3a6c8bcfebeeda352286f46afda00b3" title="The class destructor does not attempt to cancel or join a thread.">~Thread</a>();
|
||||
<a name="l00057"></a>00057
|
||||
<a name="l00062"></a>00062 <span class="keywordtype">bool</span> <a class="code" href="classThread.html#a2">start</a>( THREAD_FUNCTION routine, <span class="keywordtype">void</span> * ptr = NULL );
|
||||
<a name="l00063"></a>00063
|
||||
<a name="l00059"></a>00059
|
||||
<a name="l00064"></a>00064 <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1Thread.html#bcafe21595d9c6ac52b1ae872b34a531" title="Begin execution of the thread routine. Upon success, true is returned.">start</a>( THREAD_FUNCTION routine, <span class="keywordtype">void</span> * ptr = NULL );
|
||||
<a name="l00065"></a>00065
|
||||
<a name="l00072"></a>00072 <span class="keywordtype">bool</span> <a class="code" href="classThread.html#a3">cancel</a>(<span class="keywordtype">void</span>);
|
||||
<a name="l00073"></a>00073
|
||||
<a name="l00067"></a>00067
|
||||
<a name="l00074"></a>00074 <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1Thread.html#7187695295a7e5faf780ca13b0c07d4e" title="Signal cancellation of a thread routine, returning true on success.">cancel</a>(<span class="keywordtype">void</span>);
|
||||
<a name="l00075"></a>00075
|
||||
<a name="l00078"></a>00078 <span class="keywordtype">bool</span> <a class="code" href="classThread.html#a4">wait</a>(<span class="keywordtype">void</span>);
|
||||
<a name="l00079"></a>00079
|
||||
<a name="l00077"></a>00077
|
||||
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1Thread.html#cce21fd2b9b62cd8116fefe499c8431f" title="Block the calling routine indefinitely until the thread terminates.">wait</a>(<span class="keywordtype">void</span>);
|
||||
<a name="l00081"></a>00081
|
||||
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <a class="code" href="classThread.html#a5">testCancel</a>(<span class="keywordtype">void</span>);
|
||||
<a name="l00087"></a>00087
|
||||
<a name="l00088"></a>00088 <span class="keyword">protected</span>:
|
||||
<a name="l00083"></a>00083
|
||||
<a name="l00088"></a>00088 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Thread.html#351cf3ad12622606ea2d984ae2e29380" title="Create a cancellation point within a thread routine.">testCancel</a>(<span class="keywordtype">void</span>);
|
||||
<a name="l00089"></a>00089
|
||||
<a name="l00090"></a>00090 THREAD_HANDLE thread_;
|
||||
<a name="l00090"></a>00090 <span class="keyword">protected</span>:
|
||||
<a name="l00091"></a>00091
|
||||
<a name="l00092"></a>00092 };
|
||||
<a name="l00092"></a>00092 THREAD_HANDLE thread_;
|
||||
<a name="l00093"></a>00093
|
||||
<a name="l00094"></a>00094 <span class="preprocessor">#endif</span>
|
||||
</pre></div><HR>
|
||||
<a name="l00094"></a>00094 };
|
||||
<a name="l00095"></a>00095
|
||||
<a name="l00096"></a>00096 } <span class="comment">// stk namespace</span>
|
||||
<a name="l00097"></a>00097
|
||||
<a name="l00098"></a>00098 <span class="preprocessor">#endif</span>
|
||||
</pre></div></div>
|
||||
<HR>
|
||||
|
||||
<table>
|
||||
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user