![]() |
pl-nk v0.4.5
Plonk|Plink|Plank are a set of cross-platform C/C++ frameworks for audio software development
|
00001 /* 00002 ------------------------------------------------------------------------------- 00003 This file is part of the Plink, Plonk, Plank libraries 00004 by Martin Robinson 00005 00006 http://code.google.com/p/pl-nk/ 00007 00008 Copyright University of the West of England, Bristol 2011-14 00009 All rights reserved. 00010 00011 Redistribution and use in source and binary forms, with or without 00012 modification, are permitted provided that the following conditions are met: 00013 00014 * Redistributions of source code must retain the above copyright 00015 notice, this list of conditions and the following disclaimer. 00016 * Redistributions in binary form must reproduce the above copyright 00017 notice, this list of conditions and the following disclaimer in the 00018 documentation and/or other materials provided with the distribution. 00019 * Neither the name of University of the West of England, Bristol nor 00020 the names of its contributors may be used to endorse or promote products 00021 derived from this software without specific prior written permission. 00022 00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 00024 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 00025 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00026 DISCLAIMED. IN NO EVENT SHALL UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL BE 00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00033 00034 This software makes use of third party libraries. For more information see: 00035 doc/license.txt included in the distribution. 00036 ------------------------------------------------------------------------------- 00037 */ 00038 00039 #ifndef PLONK_THREAD_H 00040 #define PLONK_THREAD_H 00041 00043 class Threading 00044 { 00045 public: 00046 typedef PlankThreadID ID; 00047 00050 static ResultCode sleep (const double seconds) throw(); 00051 00054 static ResultCode yield() throw(); 00055 00057 static Threading::ID getCurrentThreadID() throw(); 00058 00059 static Threading::ID getAudioThreadID() throw(); // there will be more that one audio thread when going multicore, not really only one actual "audio thread" 00060 static bool setAudioThreadID (const Threading::ID theID) throw(); 00061 static bool currentThreadIsAudioThread() throw(); 00062 00093 class Thread // do not inherit from PlonkBase - threads need to managed carefully 00094 { 00095 public: 00096 Thread (const char* name = 0) throw(); 00097 virtual ~Thread(); 00098 00099 ResultCode start() throw(); 00100 ResultCode cancel() throw(); 00101 00106 ResultCode wait() throw(); 00107 00108 ResultCode pause (const double duration = PLONK_INFINITY) throw(); 00109 ResultCode resume() throw(); 00110 00113 bool isRunning() throw(); 00114 00118 ResultCode setShouldExit() throw(); 00119 00124 ResultCode setShouldExitAndWait (const double interval = 0.000001) throw(); 00125 00128 bool getShouldExit() throw(); 00129 00130 bool setPriority (const int priority) throw(); 00131 bool setPriorityAudio (const int blockSize, const double sampleRate) throw(); 00132 00134 Threading::ID getID() throw(); 00135 00137 virtual ResultCode run() = 0; 00138 00139 protected: 00141 static ResultCode sleep (const double seconds) throw(); 00142 00144 static ResultCode yield() throw(); 00145 00146 private: 00147 inline PlankThreadRef getPeerRef() { return &thread; } 00148 00149 PLONK_ALIGN(16) 00150 PlankThread thread; 00151 00152 Thread (Thread const&); 00153 Thread& operator= (Thread const&); 00154 }; 00155 00156 friend class Thread; 00157 00158 private: 00159 static PlankResult run (PlankThreadRef plankThread) throw(); 00160 }; 00161 00162 00163 00164 00165 00166 #endif // PLONK_THREAD_H