class timed_mutex

Declaration

class timed_mutex : private mutex { /* full declaration omitted */ };

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/synchronization/include/pika/synchronization/mutex.hpp:73

Inherits from: mutex

Method Overview

• public timed_mutex(const char *const description = "")
• public bool try_lock_for(const pika::chrono::steady_duration & rel_time, const char * description, pika::error_code & ec = throws)
• public bool try_lock_for(const pika::chrono::steady_duration & rel_time, pika::error_code & ec = throws)
• public bool try_lock_until(const pika::chrono::steady_time_point & abs_time, const char * description, pika::error_code & ec = throws)
• public bool try_lock_until(const pika::chrono::steady_time_point & abs_time, pika::error_code & ec = throws)
• public ~timed_mutex()

Methods

timed_mutex(const char* const description = "")

Declared at: libs/pika/synchronization/include/pika/synchronization/mutex.hpp:79

Parameters

const char* const description = ""

bool try_lock_for(
    const pika::chrono::steady_duration& rel_time,
    const char* description,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/mutex.hpp:97

Parameters

const pika::chrono::steady_duration& rel_time

const char* description

pika::error_code& ec = throws

bool try_lock_for(
    const pika::chrono::steady_duration& rel_time,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/mutex.hpp:103

Parameters

const pika::chrono::steady_duration& rel_time

pika::error_code& ec = throws

bool try_lock_until(
    const pika::chrono::steady_time_point&
        abs_time,
    const char* description,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/mutex.hpp:87

Parameters

const pika::chrono::steady_time_point& abs_time

const char* description

pika::error_code& ec = throws

bool try_lock_until(
    const pika::chrono::steady_time_point&
        abs_time,
    pika::error_code& ec = throws)

Declared at: libs/pika/synchronization/include/pika/synchronization/mutex.hpp:91

Parameters

const pika::chrono::steady_time_point& abs_time

pika::error_code& ec = throws

~timed_mutex()

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