File: Thread_8h_source.html

package info (click to toggle)
stk 4.4.4-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 24,856 kB
  • sloc: cpp: 33,976; tcl: 2,375; sh: 2,319; ansic: 163; perl: 114; makefile: 37
file content (81 lines) | stat: -rw-r--r-- 6,480 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<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"> &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="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.6.2 -->
  <div class="navpath"><a class="el" href="dir_221deb9bdff892d63ed1e409450a60d2.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 &quot;Stk.h&quot;</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 &lt;pthread.h&gt;</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 &lt;windows.h&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">  #include &lt;process.h&gt;</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">#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#a550db7efe16cd4ef223d9ca69dda384b" title="Default constructor.">Thread</a>();
<a name="l00054"></a>00054 
<a name="l00056"></a>00056   <a class="code" href="classstk_1_1Thread.html#af3a6c8bcfebeeda352286f46afda00b3" title="The class destructor does not attempt to cancel or join a thread.">~Thread</a>();
<a name="l00057"></a>00057 
<a name="l00059"></a>00059 
<a name="l00064"></a>00064   <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1Thread.html#abcafe21595d9c6ac52b1ae872b34a531" 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="l00067"></a>00067 
<a name="l00074"></a>00074   <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1Thread.html#a7187695295a7e5faf780ca13b0c07d4e" 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="l00077"></a>00077 
<a name="l00080"></a>00080   <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1Thread.html#acce21fd2b9b62cd8116fefe499c8431f" title="Block the calling routine indefinitely until the thread terminates.">wait</a>(<span class="keywordtype">void</span>);
<a name="l00081"></a>00081 
<a name="l00083"></a>00083 
<a name="l00088"></a>00088   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Thread.html#a351cf3ad12622606ea2d984ae2e29380" 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  <span class="keyword">protected</span>:
<a name="l00091"></a>00091 
<a name="l00092"></a>00092   THREAD_HANDLE thread_;
<a name="l00093"></a>00093 
<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>&copy;1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>

</BODY>
</HTML>