<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Jack2: JackThread.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Jack2 <span id="projectnumber">1.9.7</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <h1>JackThread.h</h1> </div> </div> <div class="contents"> <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2001 Paul Davis</span> <a name="l00003"></a>00003 <span class="comment"> Copyright (C) 2004-2008 Grame</span> <a name="l00004"></a>00004 <span class="comment"></span> <a name="l00005"></a>00005 <span class="comment"> This program is free software; you can redistribute it and/or modify</span> <a name="l00006"></a>00006 <span class="comment"> it under the terms of the GNU Lesser General Public License as published by</span> <a name="l00007"></a>00007 <span class="comment"> the Free Software Foundation; either version 2.1 of the License, or</span> <a name="l00008"></a>00008 <span class="comment"> (at your option) any later version.</span> <a name="l00009"></a>00009 <span class="comment"></span> <a name="l00010"></a>00010 <span class="comment"> This program is distributed in the hope that it will be useful,</span> <a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00013"></a>00013 <span class="comment"> GNU Lesser General Public License for more details.</span> <a name="l00014"></a>00014 <span class="comment"></span> <a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span> <a name="l00016"></a>00016 <span class="comment"> along with this program; if not, write to the Free Software</span> <a name="l00017"></a>00017 <span class="comment"> Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span> <a name="l00018"></a>00018 <span class="comment"></span> <a name="l00019"></a>00019 <span class="comment"> */</span> <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="preprocessor">#ifndef __JackThread__</span> <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __JackThread__</span> <a name="l00023"></a>00023 <span class="preprocessor"></span> <a name="l00024"></a>00024 <span class="preprocessor">#include "JackCompilerDeps.h"</span> <a name="l00025"></a>00025 <span class="preprocessor">#include "JackTypes.h"</span> <a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="keyword">namespace </span>Jack <a name="l00028"></a>00028 { <a name="l00029"></a>00029 <a name="l00034"></a><a class="code" href="classJack_1_1JackRunnableInterface.html">00034</a> <span class="keyword">class </span><a class="code" href="classJack_1_1JackRunnableInterface.html" title="The base class for runnable objects, that have an Init and Execute method to be called in a threa...">JackRunnableInterface</a> <a name="l00035"></a>00035 { <a name="l00036"></a>00036 <a name="l00037"></a>00037 <span class="keyword">protected</span>: <a name="l00038"></a>00038 <a name="l00039"></a>00039 <a class="code" href="classJack_1_1JackRunnableInterface.html" title="The base class for runnable objects, that have an Init and Execute method to be called in a threa...">JackRunnableInterface</a>() <a name="l00040"></a>00040 {} <a name="l00041"></a>00041 <span class="keyword">virtual</span> ~<a class="code" href="classJack_1_1JackRunnableInterface.html" title="The base class for runnable objects, that have an Init and Execute method to be called in a threa...">JackRunnableInterface</a>() <a name="l00042"></a>00042 {} <a name="l00043"></a>00043 <a name="l00044"></a>00044 <span class="keyword">public</span>: <a name="l00045"></a>00045 <a name="l00046"></a><a class="code" href="classJack_1_1JackRunnableInterface.html#aa47e1c4d13d09e7240d73bb5e8079d22">00046</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classJack_1_1JackRunnableInterface.html#aa47e1c4d13d09e7240d73bb5e8079d22">Init</a>() <a name="l00047"></a>00047 { <a name="l00048"></a>00048 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00049"></a>00049 } <a name="l00050"></a>00050 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Execute() = 0; <a name="l00051"></a>00051 }; <a name="l00052"></a>00052 <a name="l00053"></a>00053 <span class="keyword">namespace </span>detail <a name="l00054"></a>00054 { <a name="l00055"></a>00055 <a name="l00060"></a><a class="code" href="classJack_1_1detail_1_1JackThreadInterface.html">00060</a> <span class="keyword">class </span>SERVER_EXPORT <a class="code" href="classJack_1_1detail_1_1JackThreadInterface.html" title="The thread base class.">JackThreadInterface</a> <a name="l00061"></a>00061 { <a name="l00062"></a>00062 <a name="l00063"></a>00063 <span class="keyword">public</span>: <a name="l00064"></a>00064 <a name="l00065"></a>00065 <span class="keyword">enum</span> kThreadState {kIdle, kStarting, kIniting, kRunning}; <a name="l00066"></a>00066 <a name="l00067"></a>00067 <span class="keyword">protected</span>: <a name="l00068"></a>00068 <a name="l00069"></a>00069 <a class="code" href="classJack_1_1JackRunnableInterface.html" title="The base class for runnable objects, that have an Init and Execute method to be called in a threa...">JackRunnableInterface</a>* fRunnable; <a name="l00070"></a>00070 <span class="keywordtype">int</span> fPriority; <a name="l00071"></a>00071 <span class="keywordtype">bool</span> fRealTime; <a name="l00072"></a>00072 <span class="keyword">volatile</span> kThreadState fStatus; <a name="l00073"></a>00073 <span class="keywordtype">int</span> fCancellation; <a name="l00074"></a>00074 <a name="l00075"></a>00075 <span class="keyword">public</span>: <a name="l00076"></a>00076 <a name="l00077"></a>00077 <a class="code" href="classJack_1_1detail_1_1JackThreadInterface.html" title="The thread base class.">JackThreadInterface</a>(<a class="code" href="classJack_1_1JackRunnableInterface.html" title="The base class for runnable objects, that have an Init and Execute method to be called in a threa...">JackRunnableInterface</a>* runnable, <span class="keywordtype">int</span> priority, <span class="keywordtype">bool</span> real_time, <span class="keywordtype">int</span> cancellation): <a name="l00078"></a>00078 fRunnable(runnable), fPriority(priority), fRealTime(real_time), fStatus(kIdle), fCancellation(cancellation) <a name="l00079"></a>00079 {} <a name="l00080"></a>00080 <a name="l00081"></a>00081 kThreadState GetStatus() <a name="l00082"></a>00082 { <a name="l00083"></a>00083 <span class="keywordflow">return</span> fStatus; <a name="l00084"></a>00084 } <a name="l00085"></a>00085 <span class="keywordtype">void</span> SetStatus(kThreadState status) <a name="l00086"></a>00086 { <a name="l00087"></a>00087 fStatus = status; <a name="l00088"></a>00088 } <a name="l00089"></a>00089 <a name="l00090"></a>00090 <span class="keywordtype">void</span> SetParams(UInt64 period, UInt64 computation, UInt64 constraint) <span class="comment">// Empty implementation, will only make sense on OSX...</span> <a name="l00091"></a>00091 {} <a name="l00092"></a>00092 <a name="l00093"></a>00093 <span class="keywordtype">int</span> Start(); <a name="l00094"></a>00094 <span class="keywordtype">int</span> StartSync(); <a name="l00095"></a>00095 <span class="keywordtype">int</span> Kill(); <a name="l00096"></a>00096 <span class="keywordtype">int</span> Stop(); <a name="l00097"></a>00097 <span class="keywordtype">void</span> Terminate(); <a name="l00098"></a>00098 <a name="l00099"></a>00099 <span class="keywordtype">int</span> AcquireRealTime(); <span class="comment">// Used when called from another thread</span> <a name="l00100"></a>00100 <span class="keywordtype">int</span> AcquireSelfRealTime(); <span class="comment">// Used when called from thread itself</span> <a name="l00101"></a>00101 <a name="l00102"></a>00102 <span class="keywordtype">int</span> AcquireRealTime(<span class="keywordtype">int</span> priority); <span class="comment">// Used when called from another thread</span> <a name="l00103"></a>00103 <span class="keywordtype">int</span> AcquireSelfRealTime(<span class="keywordtype">int</span> priority); <span class="comment">// Used when called from thread itself</span> <a name="l00104"></a>00104 <a name="l00105"></a>00105 <span class="keywordtype">int</span> DropRealTime(); <span class="comment">// Used when called from another thread</span> <a name="l00106"></a>00106 <span class="keywordtype">int</span> DropSelfRealTime(); <span class="comment">// Used when called from thread itself</span> <a name="l00107"></a>00107 <a name="l00108"></a>00108 jack_native_thread_t GetThreadID(); <a name="l00109"></a>00109 <span class="keywordtype">bool</span> IsThread(); <a name="l00110"></a>00110 <a name="l00111"></a>00111 <span class="keyword">static</span> <span class="keywordtype">int</span> AcquireRealTimeImp(jack_native_thread_t thread, <span class="keywordtype">int</span> priority); <a name="l00112"></a>00112 <span class="keyword">static</span> <span class="keywordtype">int</span> AcquireRealTimeImp(jack_native_thread_t thread, <span class="keywordtype">int</span> priority, UInt64 period, UInt64 computation, UInt64 constraint); <a name="l00113"></a>00113 <span class="keyword">static</span> <span class="keywordtype">int</span> DropRealTimeImp(jack_native_thread_t thread); <a name="l00114"></a>00114 <span class="keyword">static</span> <span class="keywordtype">int</span> StartImp(jack_native_thread_t* thread, <span class="keywordtype">int</span> priority, <span class="keywordtype">int</span> realtime, <span class="keywordtype">void</span>*(*start_routine)(<span class="keywordtype">void</span>*), <span class="keywordtype">void</span>* arg); <a name="l00115"></a>00115 <span class="keyword">static</span> <span class="keywordtype">int</span> StopImp(jack_native_thread_t thread); <a name="l00116"></a>00116 <span class="keyword">static</span> <span class="keywordtype">int</span> KillImp(jack_native_thread_t thread); <a name="l00117"></a>00117 }; <a name="l00118"></a>00118 <a name="l00119"></a>00119 } <a name="l00120"></a>00120 <a name="l00121"></a>00121 } <span class="comment">// end of namespace</span> <a name="l00122"></a>00122 <a name="l00123"></a>00123 <span class="keywordtype">bool</span> jack_get_thread_realtime_priority_range(<span class="keywordtype">int</span> * min_ptr, <span class="keywordtype">int</span> * max_ptr); <a name="l00124"></a>00124 <a name="l00125"></a>00125 <span class="keywordtype">bool</span> jack_tls_allocate_key(jack_tls_key *key_ptr); <a name="l00126"></a>00126 <span class="keywordtype">bool</span> jack_tls_free_key(jack_tls_key key); <a name="l00127"></a>00127 <a name="l00128"></a>00128 <span class="keywordtype">bool</span> jack_tls_set(jack_tls_key key, <span class="keywordtype">void</span> *data_ptr); <a name="l00129"></a>00129 <span class="keywordtype">void</span> *jack_tls_get(jack_tls_key key); <a name="l00130"></a>00130 <a name="l00131"></a>00131 <span class="preprocessor">#endif</span> </pre></div></div> </div> <hr size="1"><address style="text-align: right;"><small> Generated for Jack2 by <a href="http://www.doxygen.org/ index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.3</small></address> </body> </html>