class condition_variable

Declaration

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

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:27

Method Overview

• public void abort_all(std::unique_lock<mutex_type> lock)
• public condition_variable()
• public bool empty(const std::unique_lock<mutex_type> & lock) const
• public void notify_all(std::unique_lock<mutex_type> lock, threads::thread_priority priority, pika::error_code & ec = throws)
• public void notify_all(std::unique_lock<mutex_type> lock, pika::error_code & ec = throws)
• public bool notify_one(std::unique_lock<mutex_type> lock, threads::thread_priority priority, pika::error_code & ec = throws)
• public bool notify_one(std::unique_lock<mutex_type> lock, pika::error_code & ec = throws)
• public std::size_t size(const std::unique_lock<mutex_type> & lock) const
• public threads::thread_restart_state wait(std::unique_lock<mutex_type> & lock, const char * description, pika::error_code & ec = throws)
• public threads::thread_restart_state wait(std::unique_lock<mutex_type> & lock, pika::error_code & ec = throws)
• public threads::thread_restart_state wait_for(std::unique_lock<mutex_type> & lock, const pika::chrono::steady_duration & rel_time, const char * description, pika::error_code & ec = throws)
• public threads::thread_restart_state wait_for(std::unique_lock<mutex_type> & lock, const pika::chrono::steady_duration & rel_time, pika::error_code & ec = throws)
• public threads::thread_restart_state wait_until(std::unique_lock<mutex_type> & lock, const pika::chrono::steady_time_point & abs_time, const char * description, pika::error_code & ec = throws)
• public threads::thread_restart_state wait_until(std::unique_lock<mutex_type> & lock, const pika::chrono::steady_time_point & abs_time, pika::error_code & ec = throws)
• public ~condition_variable()

Methods

void abort_all(std::unique_lock<mutex_type> lock)

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

Parameters

std::unique_lock<mutex_type> lock

condition_variable()

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:83

bool empty(const std::unique_lock<mutex_type>&
               lock) const

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:87

Parameters

const std::unique_lock<mutex_type>& lock

void notify_all(std::unique_lock<mutex_type> lock,
                threads::thread_priority priority,
                pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:97

Parameters

std::unique_lock<mutex_type> lock

threads::thread_priority priority

pika::error_code& ec = throws

void notify_all(std::unique_lock<mutex_type> lock,
                pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:107

Parameters

std::unique_lock<mutex_type> lock

pika::error_code& ec = throws

bool notify_one(std::unique_lock<mutex_type> lock,
                threads::thread_priority priority,
                pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:94

Parameters

std::unique_lock<mutex_type> lock

threads::thread_priority priority

pika::error_code& ec = throws

bool notify_one(std::unique_lock<mutex_type> lock,
                pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:100

Parameters

std::unique_lock<mutex_type> lock

pika::error_code& ec = throws

std::size_t size(
    const std::unique_lock<mutex_type>& lock)
    const

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:89

Parameters

const std::unique_lock<mutex_type>& lock

threads::thread_restart_state wait(
    std::unique_lock<mutex_type>& lock,
    const char* description,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:116

Parameters

std::unique_lock<mutex_type>& lock

const char* description

pika::error_code& ec = throws

threads::thread_restart_state wait(
    std::unique_lock<mutex_type>& lock,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:120

Parameters

std::unique_lock<mutex_type>& lock

pika::error_code& ec = throws

threads::thread_restart_state wait_for(
    std::unique_lock<mutex_type>& lock,
    const pika::chrono::steady_duration& rel_time,
    const char* description,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:140

Parameters

std::unique_lock<mutex_type>& lock

const pika::chrono::steady_duration& rel_time

const char* description

pika::error_code& ec = throws

threads::thread_restart_state wait_for(
    std::unique_lock<mutex_type>& lock,
    const pika::chrono::steady_duration& rel_time,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:148

Parameters

std::unique_lock<mutex_type>& lock

const pika::chrono::steady_duration& rel_time

pika::error_code& ec = throws

threads::thread_restart_state wait_until(
    std::unique_lock<mutex_type>& lock,
    const pika::chrono::steady_time_point&
        abs_time,
    const char* description,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:126

Parameters

std::unique_lock<mutex_type>& lock

const pika::chrono::steady_time_point& abs_time

const char* description

pika::error_code& ec = throws

threads::thread_restart_state wait_until(
    std::unique_lock<mutex_type>& lock,
    const pika::chrono::steady_time_point&
        abs_time,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:131

Parameters

std::unique_lock<mutex_type>& lock

const pika::chrono::steady_time_point& abs_time

pika::error_code& ec = throws

~condition_variable()

Declared at: libs/pika/synchronization/include/pika/synchronization/detail/condition_variable.hpp:85