A selection of options available when creating realtime threads. More...
Public Member Functions | |
RealtimeOptions | withPriority (int newPriority) const |
A value with a range of 0-10, where 10 is the highest priority. | |
RealtimeOptions | withProcessingTimeMs (double newProcessingTimeMs) const |
Specify the expected amount of processing time required each time the thread wakes up. | |
RealtimeOptions | withMaximumProcessingTimeMs (double newMaximumProcessingTimeMs) const |
Specify the maximum amount of processing time required each time the thread wakes up. | |
RealtimeOptions | withPeriodMs (double newPeriodMs) const |
Specify the approximate amount of time between each thread wake up. | |
RealtimeOptions | withPeriodHz (double newPeriodHz) const |
Specify the approximate frequency at which the thread will be woken up. | |
int | getPriority () const |
Returns a value with a range of 0-10, where 10 is the highest priority. | |
std::optional< double > | getProcessingTimeMs () const |
Returns the expected amount of processing time required each time the thread wakes up. | |
std::optional< double > | getMaximumProcessingTimeMs () const |
Returns the maximum amount of processing time required each time the thread wakes up. | |
std::optional< double > | getPeriodMs () const |
Returns the approximate amount of time between each thread wake up, or nullopt if there is no inherent periodicity. | |
A selection of options available when creating realtime threads.
RealtimeOptions Thread::RealtimeOptions::withPriority | ( | int | newPriority | ) | const |
A value with a range of 0-10, where 10 is the highest priority.
Currently only used by Posix platforms.
References isPositiveAndNotGreaterThan(), jassert, and withMember().
RealtimeOptions Thread::RealtimeOptions::withProcessingTimeMs | ( | double | newProcessingTimeMs | ) | const |
Specify the expected amount of processing time required each time the thread wakes up.
Only used by macOS/iOS.
References jassert, and withMember().
RealtimeOptions Thread::RealtimeOptions::withMaximumProcessingTimeMs | ( | double | newMaximumProcessingTimeMs | ) | const |
Specify the maximum amount of processing time required each time the thread wakes up.
Only used by macOS/iOS.
References jassert, and withMember().
RealtimeOptions Thread::RealtimeOptions::withPeriodMs | ( | double | newPeriodMs | ) | const |
Specify the approximate amount of time between each thread wake up.
Alternatively call withPeriodHz().
Only used by macOS/iOS.
References jassert, and withMember().
RealtimeOptions Thread::RealtimeOptions::withPeriodHz | ( | double | newPeriodHz | ) | const |
Specify the approximate frequency at which the thread will be woken up.
Alternatively call withPeriodMs().
Only used by macOS/iOS.
References jassert.
int Thread::RealtimeOptions::getPriority | ( | ) | const |
Returns a value with a range of 0-10, where 10 is the highest priority.
std::optional< double > Thread::RealtimeOptions::getProcessingTimeMs | ( | ) | const |
Returns the expected amount of processing time required each time the thread wakes up.
std::optional< double > Thread::RealtimeOptions::getMaximumProcessingTimeMs | ( | ) | const |
Returns the maximum amount of processing time required each time the thread wakes up.
std::optional< double > Thread::RealtimeOptions::getPeriodMs | ( | ) | const |
Returns the approximate amount of time between each thread wake up, or nullopt if there is no inherent periodicity.