class condition_variable

Declaration

class condition_variable { /* full declaration omitted */ };

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:36

Method Overview

• public condition_variable()
• public void notify_all(pika::error_code & ec = throws)
• public void notify_one(pika::error_code & ec = throws)
• public template <typename Mutex>void wait(std::unique_lock<Mutex> & lock, pika::error_code & ec = throws)
• public template <typename Mutex, typename Predicate>void wait(std::unique_lock<Mutex> & lock, Predicate pred, pika::error_code & = throws)
• public template <typename Mutex>pika::lcos::local::cv_status wait_for(std::unique_lock<Mutex> & lock, const pika::chrono::steady_duration & rel_time, pika::error_code & ec = throws)
• public template <typename Mutex, typename Predicate>bool wait_for(std::unique_lock<Mutex> & lock, const pika::chrono::steady_duration & rel_time, Predicate pred, pika::error_code & ec = throws)
• public template <typename Mutex>pika::lcos::local::cv_status wait_until(std::unique_lock<Mutex> & lock, const pika::chrono::steady_time_point & abs_time, pika::error_code & ec = throws)
• public template <typename Mutex, typename Predicate>bool wait_until(std::unique_lock<Mutex> & lock, const pika::chrono::steady_time_point & abs_time, Predicate pred, pika::error_code & ec = throws)
• public ~condition_variable()

Methods

condition_variable()

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:44

void notify_all(pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:74

Parameters

pika::error_code& ec = throws

void notify_one(pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:68

Parameters

pika::error_code& ec = throws

template <typename Mutex>
void wait(std::unique_lock<Mutex>& lock,
          pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:81

Parameters

std::unique_lock<Mutex>& lock

pika::error_code& ec = throws

template <typename Mutex, typename Predicate>
void wait(std::unique_lock<Mutex>& lock,
          Predicate pred,
          pika::error_code& = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:102

Parameters

std::unique_lock<Mutex>& lock

Predicate pred

pika::error_code& = throws

template <typename Mutex>
pika::lcos::local::cv_status wait_for(
    std::unique_lock<Mutex>& lock,
    const pika::chrono::steady_duration& rel_time,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:162

Parameters

std::unique_lock<Mutex>& lock

const pika::chrono::steady_duration& rel_time

pika::error_code& ec = throws

template <typename Mutex, typename Predicate>
bool wait_for(
    std::unique_lock<Mutex>& lock,
    const pika::chrono::steady_duration& rel_time,
    Predicate pred,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:170

Parameters

std::unique_lock<Mutex>& lock

const pika::chrono::steady_duration& rel_time

Predicate pred

pika::error_code& ec = throws

template <typename Mutex>
pika::lcos::local::cv_status wait_until(
    std::unique_lock<Mutex>& lock,
    const pika::chrono::steady_time_point&
        abs_time,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:114

Parameters

std::unique_lock<Mutex>& lock

const pika::chrono::steady_time_point& abs_time

pika::error_code& ec = throws

template <typename Mutex, typename Predicate>
bool wait_until(
    std::unique_lock<Mutex>& lock,
    const pika::chrono::steady_time_point&
        abs_time,
    Predicate pred,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:147

Parameters

std::unique_lock<Mutex>& lock

const pika::chrono::steady_time_point& abs_time

Predicate pred

pika::error_code& ec = throws

~condition_variable()

Declared at: libs/pika/synchronization/include/pika/synchronization/condition_variable.hpp:66