Enhanced condition variable wrapper with timeout and predicate support. More...

#include <sync_primitives.h>

Collaboration diagram for kcenon::thread::sync::condition_variable_wrapper:

Public Member Functions
	condition_variable_wrapper ()=default

	~condition_variable_wrapper ()=default

	condition_variable_wrapper (const condition_variable_wrapper &)=delete

condition_variable_wrapper &	operator= (const condition_variable_wrapper &)=delete

	condition_variable_wrapper (condition_variable_wrapper &&)=default

condition_variable_wrapper &	operator= (condition_variable_wrapper &&)=default

template<typename Lock >
void	wait (Lock &lock)
	Wait indefinitely for notification.

template<typename Lock , typename Predicate >
void	wait (Lock &lock, Predicate predicate)
	Wait with predicate until condition is met.

template<typename Lock , typename Rep , typename Period >
bool	wait_for (Lock &lock, const std::chrono::duration< Rep, Period > &timeout)
	Wait with timeout.

template<typename Lock , typename Rep , typename Period , typename Predicate >
bool	wait_for (Lock &lock, const std::chrono::duration< Rep, Period > &timeout, Predicate predicate)
	Wait with timeout and predicate.

void	notify_one () noexcept
	Notify one waiting thread.

void	notify_all () noexcept
	Notify all waiting threads.

	condition_variable_wrapper ()=default

	~condition_variable_wrapper ()=default

	condition_variable_wrapper (const condition_variable_wrapper &)=delete

condition_variable_wrapper &	operator= (const condition_variable_wrapper &)=delete

	condition_variable_wrapper (condition_variable_wrapper &&)=default

condition_variable_wrapper &	operator= (condition_variable_wrapper &&)=default

template<typename Lock >
void	wait (Lock &lock)
	Wait indefinitely for notification.

template<typename Lock , typename Predicate >
void	wait (Lock &lock, Predicate predicate)
	Wait with predicate until condition is met.

template<typename Lock , typename Rep , typename Period >
bool	wait_for (Lock &lock, const std::chrono::duration< Rep, Period > &timeout)
	Wait with timeout.

template<typename Lock , typename Rep , typename Period , typename Predicate >
bool	wait_for (Lock &lock, const std::chrono::duration< Rep, Period > &timeout, Predicate predicate)
	Wait with timeout and predicate.

void	notify_one () noexcept
	Notify one waiting thread.

void	notify_all () noexcept
	Notify all waiting threads.

Private Attributes
std::condition_variable	cv_

Detailed Description

Enhanced condition variable wrapper with timeout and predicate support.

Definition at line 96 of file sync_primitives.h.

Constructor & Destructor Documentation

◆ condition_variable_wrapper() [1/6]

kcenon::thread::sync::condition_variable_wrapper::condition_variable_wrapper ( )

default

◆ ~condition_variable_wrapper() [1/2]

kcenon::thread::sync::condition_variable_wrapper::~condition_variable_wrapper ( )

default

◆ condition_variable_wrapper() [2/6]

kcenon::thread::sync::condition_variable_wrapper::condition_variable_wrapper ( const condition_variable_wrapper & )

delete

◆ condition_variable_wrapper() [3/6]

kcenon::thread::sync::condition_variable_wrapper::condition_variable_wrapper ( condition_variable_wrapper && )

default

◆ condition_variable_wrapper() [4/6]

kcenon::thread::sync::condition_variable_wrapper::condition_variable_wrapper ( )

default

◆ ~condition_variable_wrapper() [2/2]

kcenon::thread::sync::condition_variable_wrapper::~condition_variable_wrapper ( )

default

◆ condition_variable_wrapper() [5/6]

kcenon::thread::sync::condition_variable_wrapper::condition_variable_wrapper ( const condition_variable_wrapper & )

delete

◆ condition_variable_wrapper() [6/6]

kcenon::thread::sync::condition_variable_wrapper::condition_variable_wrapper ( condition_variable_wrapper && )

default

Member Function Documentation

◆ notify_all() [1/2]

void kcenon::thread::sync::condition_variable_wrapper::notify_all ( )

inlinenoexcept

Notify all waiting threads.

Definition at line 153 of file sync_primitives.h.

                                   {
            cv_.notify_all();
        }

References cv_.

◆ notify_all() [2/2]

void kcenon::thread::sync::condition_variable_wrapper::notify_all ( )

inlinenoexcept

Notify all waiting threads.

Definition at line 159 of file sync_primitives.h.

                                   {
            cv_.notify_all();
        }

References cv_.

◆ notify_one() [1/2]

void kcenon::thread::sync::condition_variable_wrapper::notify_one ( )

inlinenoexcept

Notify one waiting thread.

Definition at line 146 of file sync_primitives.h.

                                   {
            cv_.notify_one();
        }

References cv_.

◆ notify_one() [2/2]

void kcenon::thread::sync::condition_variable_wrapper::notify_one ( )

inlinenoexcept

Notify one waiting thread.

Definition at line 152 of file sync_primitives.h.

                                   {
            cv_.notify_one();
        }

References cv_.

◆ operator=() [1/4]

condition_variable_wrapper & kcenon::thread::sync::condition_variable_wrapper::operator= ( condition_variable_wrapper && )

default

◆ operator=() [2/4]

condition_variable_wrapper & kcenon::thread::sync::condition_variable_wrapper::operator= ( condition_variable_wrapper && )

default

◆ operator=() [3/4]

condition_variable_wrapper & kcenon::thread::sync::condition_variable_wrapper::operator= ( const condition_variable_wrapper & )

delete

◆ operator=() [4/4]

condition_variable_wrapper & kcenon::thread::sync::condition_variable_wrapper::operator= ( const condition_variable_wrapper & )

delete

◆ wait() [1/4]

template<typename Lock >

void kcenon::thread::sync::condition_variable_wrapper::wait ( Lock & lock )

inline

Wait indefinitely for notification.

Parameters

lock	Unique lock that must be held by calling thread

Definition at line 106 of file sync_primitives.h.

                              {
            cv_.wait(lock);
        }

References cv_.

◆ wait() [2/4]

template<typename Lock >

void kcenon::thread::sync::condition_variable_wrapper::wait ( Lock & lock )

inline

Wait indefinitely for notification.

Parameters

lock	Unique lock that must be held by calling thread

Definition at line 112 of file sync_primitives.h.

                              {
            cv_.wait(lock);
        }

References cv_.

◆ wait() [3/4]

template<typename Lock , typename Predicate >

void kcenon::thread::sync::condition_variable_wrapper::wait	(	Lock &	lock,
		Predicate	predicate )

inline

Wait with predicate until condition is met.

Parameters

lock	Unique lock that must be held by calling thread
predicate	Function that returns true when waiting should stop

Definition at line 116 of file sync_primitives.h.

                                                   {
            cv_.wait(lock, predicate);
        }

References cv_.

◆ wait() [4/4]

template<typename Lock , typename Predicate >

void kcenon::thread::sync::condition_variable_wrapper::wait	(	Lock &	lock,
		Predicate	predicate )

inline

Wait with predicate until condition is met.

Parameters

lock	Unique lock that must be held by calling thread
predicate	Function that returns true when waiting should stop

Definition at line 122 of file sync_primitives.h.

                                                   {
            cv_.wait(lock, predicate);
        }

References cv_.

◆ wait_for() [1/4]

template<typename Lock , typename Rep , typename Period >

bool kcenon::thread::sync::condition_variable_wrapper::wait_for	(	Lock &	lock,
		const std::chrono::duration< Rep, Period > &	timeout )

inline

Wait with timeout.

Parameters

lock	Unique lock that must be held by calling thread
timeout	Maximum time to wait

Returns: true if notified before timeout, false if timeout occurred

Definition at line 127 of file sync_primitives.h.

                                                                                 {
            return cv_.wait_for(lock, timeout) == std::cv_status::no_timeout;
        }

References cv_.

◆ wait_for() [2/4]

template<typename Lock , typename Rep , typename Period >

bool kcenon::thread::sync::condition_variable_wrapper::wait_for	(	Lock &	lock,
		const std::chrono::duration< Rep, Period > &	timeout )

inline

Wait with timeout.

Parameters

lock	Unique lock that must be held by calling thread
timeout	Maximum time to wait

Returns: true if notified before timeout, false if timeout occurred

Definition at line 133 of file sync_primitives.h.

                                                                                 {
            return cv_.wait_for(lock, timeout) == std::cv_status::no_timeout;
        }

References cv_.

◆ wait_for() [3/4]

template<typename Lock , typename Rep , typename Period , typename Predicate >

bool kcenon::thread::sync::condition_variable_wrapper::wait_for	(	Lock &	lock,
		const std::chrono::duration< Rep, Period > &	timeout,
		Predicate	predicate )

inline

Wait with timeout and predicate.

Parameters

lock	Unique lock that must be held by calling thread
timeout	Maximum time to wait
predicate	Function that returns true when waiting should stop

Returns: true if predicate became true before timeout

Definition at line 139 of file sync_primitives.h.

                                                                                                      {
            return cv_.wait_for(lock, timeout, predicate);
        }

References cv_.

◆ wait_for() [4/4]

template<typename Lock , typename Rep , typename Period , typename Predicate >

bool kcenon::thread::sync::condition_variable_wrapper::wait_for	(	Lock &	lock,
		const std::chrono::duration< Rep, Period > &	timeout,
		Predicate	predicate )

inline

Wait with timeout and predicate.

Parameters

lock	Unique lock that must be held by calling thread
timeout	Maximum time to wait
predicate	Function that returns true when waiting should stop

Returns: true if predicate became true before timeout

Definition at line 145 of file sync_primitives.h.

                                                                                                      {
            return cv_.wait_for(lock, timeout, predicate);
        }

References cv_.

Member Data Documentation

◆ cv_

std::condition_variable kcenon::thread::sync::condition_variable_wrapper::cv_

private

Definition at line 158 of file sync_primitives.h.

Referenced by notify_all(), notify_one(), wait(), wait(), wait_for(), and wait_for().

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

core/sync/include/sync_primitives.h
include/kcenon/thread/core/sync_primitives.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ condition_variable_wrapper() [1/6]

◆ ~condition_variable_wrapper() [1/2]

◆ condition_variable_wrapper() [2/6]

◆ condition_variable_wrapper() [3/6]

◆ condition_variable_wrapper() [4/6]

◆ ~condition_variable_wrapper() [2/2]

◆ condition_variable_wrapper() [5/6]

◆ condition_variable_wrapper() [6/6]

Member Function Documentation

◆ notify_all() [1/2]

◆ notify_all() [2/2]

◆ notify_one() [1/2]

◆ notify_one() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ wait() [1/4]

◆ wait() [2/4]

◆ wait() [3/4]

◆ wait() [4/4]

◆ wait_for() [1/4]

◆ wait_for() [2/4]

◆ wait_for() [3/4]

◆ wait_for() [4/4]

Member Data Documentation

◆ cv_