hpx::mutex

Defined in header hpx/mutex.hpp.

See Public API for a list of names and headers that are part of the public HPX API.

See also:

• hpx::timed_mutex

class mutex

mutex class is a synchronization primitive that can be used to protect shared data from being simultaneously accessed by multiple threads. mutex offers exclusive, non-recursive ownership semantics:

• A calling thread owns a mutex from the time that it successfully calls either lock or try_lock until it calls unlock.

• When a thread owns a mutex, all other threads will block (for calls to lock) or receive a false return value (for try_lock) if they attempt to claim ownership of the mutex.

• A calling thread must not own the mutex prior to calling lock or try_lock.

The behavior of a program is undefined if a mutex is destroyed while still owned by any threads, or a thread terminates while owning a mutex. The mutex class satisfies all requirements of <a and <a.

hpx::mutex is neither copyable nor movable.

Subclassed by hpx::timed_mutex