Home Information Classes Download Usage Mail List Requirements Links FAQ Tutorial
STK mutex class. More...
#include <Mutex.h>
Public Member Functions | |
Mutex () | |
Default constructor. | |
~Mutex () | |
Class destructor. | |
void | lock (void) |
Lock the mutex. | |
void | unlock (void) |
Unlock the mutex. | |
void | wait (void) |
Wait indefinitely on the mutex condition variable. | |
void | signal (void) |
Signal the condition variable. | |
![]() | |
void | ignoreSampleRateChange (bool ignore=true) |
A function to enable/disable the automatic updating of class data when the STK sample rate changes. | |
Additional Inherited Members | |
![]() | |
static StkFloat | sampleRate (void) |
Static method that returns the current STK sample rate. | |
static void | setSampleRate (StkFloat rate) |
Static method that sets the STK sample rate. | |
static void | clear_alertList () |
Static method that frees memory from alertList_. | |
static std::string | rawwavePath (void) |
Static method that returns the current rawwave path. | |
static void | setRawwavePath (std::string path) |
Static method that sets the STK rawwave path. | |
static void | swap16 (unsigned char *ptr) |
Static method that byte-swaps a 16-bit data type. | |
static void | swap32 (unsigned char *ptr) |
Static method that byte-swaps a 32-bit data type. | |
static void | swap64 (unsigned char *ptr) |
Static method that byte-swaps a 64-bit data type. | |
static void | sleep (unsigned long milliseconds) |
Static cross-platform method to sleep for a number of milliseconds. | |
static bool | inRange (StkFloat value, StkFloat min, StkFloat max) |
Static method to check whether a value is within a specified range. | |
static void | handleError (const char *message, StkError::Type type) |
Static function for error reporting and handling using c-strings. | |
static void | handleError (std::string message, StkError::Type type) |
Static function for error reporting and handling using c++ strings. | |
static void | showWarnings (bool status) |
Toggle display of WARNING and STATUS messages. | |
static void | printErrors (bool status) |
Toggle display of error messages before throwing exceptions. | |
![]() | |
static const StkFormat | STK_SINT8 |
static const StkFormat | STK_SINT16 |
static const StkFormat | STK_SINT24 |
static const StkFormat | STK_SINT32 |
static const StkFormat | STK_FLOAT32 |
static const StkFormat | STK_FLOAT64 |
![]() | |
Stk (void) | |
Default constructor. | |
virtual | ~Stk (void) |
Class destructor. | |
virtual void | sampleRateChanged (StkFloat newRate, StkFloat oldRate) |
This function should be implemented in subclasses that depend on the sample rate. | |
void | addSampleRateAlert (Stk *ptr) |
Add class pointer to list for sample rate change notification. | |
void | removeSampleRateAlert (Stk *ptr) |
Remove class pointer from list for sample rate change notification. | |
void | handleError (StkError::Type type) const |
Internal function for error reporting that assumes message in oStream_ variable. | |
STK mutex class.
This class provides a uniform interface for cross-platform mutex use. On Linux and IRIX systems, the pthread library is used. Under Windows, critical sections are used.
by Perry R. Cook and Gary P. Scavone, 1995–2023.
void stk::Mutex::wait | ( | void | ) |
Wait indefinitely on the mutex condition variable.
The mutex must be locked before calling this function, and then subsequently unlocked after this function returns.
void stk::Mutex::signal | ( | void | ) |
Signal the condition variable.
The mutex must be locked before calling this function, and then subsequently unlocked after this function returns.
The Synthesis ToolKit in C++ (STK) |
©1995--2023 Perry R. Cook and Gary P. Scavone. All Rights Reserved. |