Skip to content

FORMUS3IC_LAS3 / embb

Go to a project
Commit 298a6e03 by Marcus Winter
Options

Merge branch 'embb567_documentation_condition_variable' into development

parents f3110892 48d2d0d1
Inline Side-by-side
Showing with 21 additions and 0 deletions
base_c/include/embb/base/c/condition_variable.h
...@@ -110,6 +110,9 @@ int embb_condition_notify_all( ...@@ -110,6 +110,9 @@ int embb_condition_notify_all(
* \threadsafe * \threadsafe
* \see embb_condition_notify_one(), embb_condition_notify_all(), * \see embb_condition_notify_one(), embb_condition_notify_all(),
* embb_condition_wait_until(), embb_condition_wait_for() * embb_condition_wait_until(), embb_condition_wait_for()
* \note It is strongly recommended checking the condition in a loop in order
* to deal with spurious wakeups and situations where another thread has
* locked the mutex between notification and wakeup.
*/ */
int embb_condition_wait( int embb_condition_wait(
embb_condition_t* condition_var, embb_condition_t* condition_var,
...@@ -131,6 +134,9 @@ int embb_condition_wait( ...@@ -131,6 +134,9 @@ int embb_condition_wait(
* \threadsafe * \threadsafe
* \see embb_condition_notify_one(), embb_condition_notify_all(), * \see embb_condition_notify_one(), embb_condition_notify_all(),
* embb_condition_wait(), embb_condition_wait_for() * embb_condition_wait(), embb_condition_wait_for()
* \note It is strongly recommended checking the condition in a loop in order
* to deal with spurious wakeups and situations where another thread has
* locked the mutex between notification and wakeup.
*/ */
int embb_condition_wait_until( int embb_condition_wait_until(
embb_condition_t* condition_var, embb_condition_t* condition_var,
...@@ -154,6 +160,9 @@ int embb_condition_wait_until( ...@@ -154,6 +160,9 @@ int embb_condition_wait_until(
* \threadsafe * \threadsafe
* \see embb_condition_notify_one(), embb_condition_notify_all(), * \see embb_condition_notify_one(), embb_condition_notify_all(),
* embb_condition_wait(), embb_condition_wait_until() * embb_condition_wait(), embb_condition_wait_until()
* \note It is strongly recommended checking the condition in a loop in order
* to deal with spurious wakeups and situations where another thread has
* locked the mutex between notification and wakeup.
*/ */
int embb_condition_wait_for( int embb_condition_wait_for(
embb_condition_t* condition_var, embb_condition_t* condition_var,
......
base_cpp/include/embb/base/condition_variable.h
...@@ -99,6 +99,10 @@ class ConditionVariable { ...@@ -99,6 +99,10 @@ class ConditionVariable {
* \threadsafe * \threadsafe
* *
* \see NotifyOne(), NotifyAll() * \see NotifyOne(), NotifyAll()
*
* \note It is strongly recommended checking the condition in a loop in order
* to deal with spurious wakeups and situations where another thread has
* locked the mutex between notification and wakeup.
*/ */
void Wait( void Wait(
UniqueLock<Mutex>& lock UniqueLock<Mutex>& lock
...@@ -118,6 +122,10 @@ class ConditionVariable { ...@@ -118,6 +122,10 @@ class ConditionVariable {
* \throws embb::base::ErrorException if an error occurred * \throws embb::base::ErrorException if an error occurred
* *
* \threadsafe * \threadsafe
*
* \note It is strongly recommended checking the condition in a loop in order
* to deal with spurious wakeups and situations where another thread has
* locked the mutex between notification and wakeup.
*/ */
bool WaitUntil( bool WaitUntil(
UniqueLock<Mutex>& lock, UniqueLock<Mutex>& lock,
...@@ -141,6 +149,10 @@ class ConditionVariable { ...@@ -141,6 +149,10 @@ class ConditionVariable {
* \threadsafe * \threadsafe
* *
* \tparam Tick Type of tick of the duration. See Duration. * \tparam Tick Type of tick of the duration. See Duration.
*
* \note It is strongly recommended checking the condition in a loop in order
* to deal with spurious wakeups and situations where another thread has
* locked the mutex between notification and wakeup.
*/ */
template<typename Tick> template<typename Tick>
bool WaitFor( bool WaitFor(
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment