distortos
v0.7.0
object-oriented C++ RTOS for microcontrollers
|
Condition-Variable-related C-API of distortos. More...
Classes | |
struct | distortos_ConditionVariable |
C-API equivalent of distortos::ConditionVariable. More... | |
Macros | |
#define | DISTORTOS_CONDITIONVARIABLE_INITIALIZER(self) {ESTD_INTRUSIVELIST_INITIALIZER((self).blockedList)} |
Initializer for distortos_ConditionVariable. More... | |
#define | DISTORTOS_CONDITIONVARIABLE_CONSTRUCT(name) struct distortos_ConditionVariable name = DISTORTOS_CONDITIONVARIABLE_INITIALIZER(name) |
C-API equivalent of distortos::ConditionVariable's constructor. More... | |
Condition-Variable-related C-API of distortos.
#define DISTORTOS_CONDITIONVARIABLE_CONSTRUCT | ( | name | ) | struct distortos_ConditionVariable name = DISTORTOS_CONDITIONVARIABLE_INITIALIZER(name) |
C-API equivalent of distortos::ConditionVariable's constructor.
[in] | name | is the name of the object that will be instantiated |
#define DISTORTOS_CONDITIONVARIABLE_INITIALIZER | ( | self | ) | {ESTD_INTRUSIVELIST_INITIALIZER((self).blockedList)} |
Initializer for distortos_ConditionVariable.
[in] | self | is an equivalent of this hidden argument |
int distortos_ConditionVariable_construct | ( | struct distortos_ConditionVariable * | conditionVariable | ) |
C-API equivalent of distortos::ConditionVariable's constructor.
Similar to std::condition_variable::condition_variable() - http://en.cppreference.com/w/cpp/thread/condition_variable/condition_variable Similar to pthread_cond_init() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_init.html
[in] | conditionVariable | is a pointer to distortos_ConditionVariable object |
int distortos_ConditionVariable_destruct | ( | struct distortos_ConditionVariable * | conditionVariable | ) |
C-API equivalent of distortos::ConditionVariable's destructor.
Similar to std::condition_variable::~condition_variable() - http://en.cppreference.com/w/cpp/thread/condition_variable/~condition_variable Similar to pthread_cond_destroy() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_destroy.html
[in] | conditionVariable | is a pointer to distortos_ConditionVariable object |
int distortos_ConditionVariable_notifyAll | ( | struct distortos_ConditionVariable * | conditionVariable | ) |
C-API equivalent of distortos::ConditionVariable::notifyAll()
Similar to std::condition_variable::notify_all() - http://en.cppreference.com/w/cpp/thread/condition_variable/notify_all Similar to pthread_cond_broadcast() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_signal.html
[in] | conditionVariable | is a pointer to distortos_ConditionVariable object |
int distortos_ConditionVariable_notifyOne | ( | struct distortos_ConditionVariable * | conditionVariable | ) |
C-API equivalent of distortos::ConditionVariable::notifyOne()
Similar to std::condition_variable::notify_one() - http://en.cppreference.com/w/cpp/thread/condition_variable/notify_one Similar to pthread_cond_signal() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_signal.html
[in] | conditionVariable | is a pointer to distortos_ConditionVariable object |
int distortos_ConditionVariable_wait | ( | struct distortos_ConditionVariable * | conditionVariable, |
struct distortos_Mutex * | mutex | ||
) |
C-API equivalent of distortos::ConditionVariable::wait()
Similar to std::condition_variable::wait() - http://en.cppreference.com/w/cpp/thread/condition_variable/wait Similar to pthread_cond_wait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_wait.html
[in] | conditionVariable | is a pointer to distortos_ConditionVariable object |
[in] | mutex | is a pointer to mutex which must be owned by calling thread |
int distortos_ConditionVariable_waitFor | ( | struct distortos_ConditionVariable * | conditionVariable, |
struct distortos_Mutex * | mutex, | ||
int64_t | duration | ||
) |
C-API equivalent of distortos::ConditionVariable::waitFor()
Similar to std::condition_variable::wait_for() - http://en.cppreference.com/w/cpp/thread/condition_variable/wait_for Similar to pthread_cond_timedwait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_timedwait.html#
[in] | conditionVariable | is a pointer to distortos_ConditionVariable object |
[in] | mutex | is a pointer to mutex which must be owned by calling thread |
[in] | duration | is the duration after which the wait for notification will be terminated |
int distortos_ConditionVariable_waitUntil | ( | struct distortos_ConditionVariable * | conditionVariable, |
struct distortos_Mutex * | mutex, | ||
int64_t | timePoint | ||
) |
C-API equivalent of distortos::ConditionVariable::waitUntil()
Similar to std::condition_variable::wait_until() - http://en.cppreference.com/w/cpp/thread/condition_variable/wait_until Similar to pthread_cond_timedwait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_timedwait.html#
[in] | conditionVariable | is a pointer to distortos_ConditionVariable object |
[in] | mutex | is a pointer to mutex which must be owned by calling thread |
[in] | timePoint | is the time point at which the wait for notification will be terminated |