riot::condition_variable Class Reference

C++11 compliant implementation of condition variable, uses the time point implemented in our chrono replacement instead of the specified one. More...

Detailed Description

C++11 compliant implementation of condition variable, uses the time point implemented in our chrono replacement instead of the specified one.

See also

std::condition_variable

Definition at line 52 of file condition_variable.hpp.

#include <condition_variable.hpp>

Public Types
using	native_handle_type = priority_queue_t *
	The native handle type used by the condition variable.

Public Member Functions
void	notify_one () noexcept
	Notify one thread waiting on this condition.
void	notify_all () noexcept
	Notify all threads waiting on this condition variable.
void	wait (unique_lock< mutex > &lock) noexcept
	Block until woken up through the condition variable.
template<class Predicate >
void	wait (unique_lock< mutex > &lock, Predicate pred)
	Block until woken up through the condition variable and a predicate is fulfilled.
cv_status	wait_until (unique_lock< mutex > &lock, const time_point &timeout_time)
	Block until woken up through the condition variable or a specified point in time is reached.
template<class Predicate >
bool	wait_until (unique_lock< mutex > &lock, const time_point &timeout_time, Predicate pred)
	Block until woken up through the condition variable and a predicate is fulfilled or a specified point in time is reached.
template<class Rep , class Period >
cv_status	wait_for (unique_lock< mutex > &lock, const std::chrono::duration< Rep, Period > &rel_time)
	Blocks until woken up through the condition variable or when the thread has been blocked for a certain time.
template<class Rep , class Period , class Predicate >
bool	wait_for (unique_lock< mutex > &lock, const std::chrono::duration< Rep, Period > &rel_time, Predicate pred)
	Blocks until woken up through the condition variable and a predicate is fulfilled or when the thread has been blocked for a certain time.
native_handle_type	native_handle ()
	Returns the native handle of the condition variable.

Member Typedef Documentation

native_handle_type

using riot::condition_variable::native_handle_type = priority_queue_t*

The native handle type used by the condition variable.

Definition at line 57 of file condition_variable.hpp.

Constructor & Destructor Documentation

condition_variable()

riot::condition_variable::condition_variable ( )

inline

Definition at line 58 of file condition_variable.hpp.

Member Function Documentation

native_handle()

native_handle_type riot::condition_variable::native_handle ( )

inline

Returns the native handle of the condition variable.

Definition at line 137 of file condition_variable.hpp.

wait() [1/2]

void riot::condition_variable::wait ( unique_lock< mutex > &  lock )

noexcept

Block until woken up through the condition variable.

Parameters

lock	A lock that is locked by the current thread.

wait() [2/2]

template<class Predicate >

void riot::condition_variable::wait	(	unique_lock< mutex > &	lock,
		Predicate	pred
	)

Block until woken up through the condition variable and a predicate is fulfilled.

Parameters

lock	A lock that is locked by the current thread.
pred	A predicate that returns a bool to signify if the thread should continue to wait when woken up through the cv.

Definition at line 147 of file condition_variable.hpp.

wait_for() [1/2]

template<class Rep , class Period >

cv_status riot::condition_variable::wait_for	(	unique_lock< mutex > &	lock,
		const std::chrono::duration< Rep, Period > &	rel_time
	)

Blocks until woken up through the condition variable or when the thread has been blocked for a certain time.

Parameters

lock	A lock that is locked by the current thread.
rel_time	The maximum time spent blocking.

Returns

A status to signify if woken up due to a timeout or the cv.

Definition at line 166 of file condition_variable.hpp.

wait_for() [2/2]

template<class Rep , class Period , class Predicate >

bool riot::condition_variable::wait_for ( unique_lock< mutex > &  lock, const std::chrono::duration< Rep, Period > &  rel_time, Predicate  pred  )

inline

Blocks until woken up through the condition variable and a predicate is fulfilled or when the thread has been blocked for a certain time.

Parameters

lock	A lock that is locked by the current thread.
rel_time	The maximum time spent blocking.
pred	A predicate that returns a bool to signify if the thread should continue to wait when woken up through the cv.

Returns

Result of the pred when the function returns.

Definition at line 189 of file condition_variable.hpp.

wait_until() [1/2]

cv_status riot::condition_variable::wait_until	(	unique_lock< mutex > &	lock,
		const time_point &	timeout_time
	)

Block until woken up through the condition variable or a specified point in time is reached.

The lock is reacquired either way.

Parameters

lock	A lock that is locked by the current thread.
timeout_time	Point in time when the thread is woken up independently of the condition variable.

Returns

A status to signify if woken up due to a timeout or the cv.

wait_until() [2/2]

template<class Predicate >

bool riot::condition_variable::wait_until	(	unique_lock< mutex > &	lock,
		const time_point &	timeout_time,
		Predicate	pred
	)

Block until woken up through the condition variable and a predicate is fulfilled or a specified point in time is reached.

The lock is reacquired either way.

Parameters

lock	A lock that is locked by the current thread.
timeout_time	Point in time when the thread is woken up independently of the condition variable.
pred	A predicate that returns a bool to signify if the thread should continue to wait when woken up through the cv.

Returns

Result of the pred when the function returns.

Definition at line 154 of file condition_variable.hpp.

---

The documentation for this class was generated from the following file:

• sys/cpp11-compat/include/riot/condition_variable.hpp