CommRaT 2.0.0
C++20 Real-Time Messaging Framework
Loading...
Searching...
No Matches
commrat::ConditionVariable Class Reference

Condition variable wrapper. More...

#include <commrat/platform/threading.hpp>

Public Member Functions

 ConditionVariable ()=default
 
 ~ConditionVariable ()=default
 
 ConditionVariable (const ConditionVariable &)=delete
 
ConditionVariableoperator= (const ConditionVariable &)=delete
 
void notify_one () noexcept
 
void notify_all () noexcept
 
void wait (std::unique_lock< std::mutex > &lock)
 
template<typename Predicate >
void wait (std::unique_lock< std::mutex > &lock, Predicate pred)
 
template<typename Rep , typename Period >
std::cv_status wait_for (std::unique_lock< std::mutex > &lock, const std::chrono::duration< Rep, Period > &rel_time)
 

Detailed Description

Condition variable wrapper.

Definition at line 318 of file threading.hpp.

Constructor & Destructor Documentation

◆ ConditionVariable() [1/2]

commrat::ConditionVariable::ConditionVariable ( )
default

◆ ~ConditionVariable()

commrat::ConditionVariable::~ConditionVariable ( )
default

◆ ConditionVariable() [2/2]

commrat::ConditionVariable::ConditionVariable ( const ConditionVariable )
delete

Member Function Documentation

◆ notify_all()

void commrat::ConditionVariable::notify_all ( )
inlinenoexcept

Definition at line 328 of file threading.hpp.

◆ notify_one()

void commrat::ConditionVariable::notify_one ( )
inlinenoexcept

Definition at line 327 of file threading.hpp.

◆ operator=()

ConditionVariable & commrat::ConditionVariable::operator= ( const ConditionVariable )
delete

◆ wait() [1/2]

void commrat::ConditionVariable::wait ( std::unique_lock< std::mutex > &  lock)
inline

Definition at line 331 of file threading.hpp.

◆ wait() [2/2]

template<typename Predicate >
void commrat::ConditionVariable::wait ( std::unique_lock< std::mutex > &  lock,
Predicate  pred 
)
inline

Definition at line 334 of file threading.hpp.

◆ wait_for()

template<typename Rep , typename Period >
std::cv_status commrat::ConditionVariable::wait_for ( std::unique_lock< std::mutex > &  lock,
const std::chrono::duration< Rep, Period > &  rel_time 
)
inline

Definition at line 339 of file threading.hpp.


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