C++ concepts: TimedMutex - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# C++ concepts: TimedMutex

From cppreference.com
< cpp‎ | concept

The `TimedMutex` concept extends the `TimedLockable` concept to include inter-thread synchronization.

### [edit] Requirements

- `TimedLockable`
- `Mutex`

Additionally, for object `m` of `TimedMutex` type.

- The expression m.try_lock_for(duration) has the following properties

  - Behaves as an atomic operation.
  - Attempts to obtain exclusive ownership of the mutex within the duration specified by `duration`. If `duration` is less or equal `duration.zero()`, attempts to obtain the ownership without locking (as if by `try_lock()`). Otherwise, this function blocks until the mutex is acquired or until the time specified by `duration` passes. It returns within `duration` only if it succeeds, but it allowed to fail to acquire the mutex even if at some point in time during `duration` it was not owned by another thread. In any case, it returns true if the mutex was acquired and false otherwise.
  - If `try_lock_for(duration)` succeeds, prior `unlock()` operations on the same object synchronize-with this operation (equivalent to release-acquire std::memory_order).
  - The behavior is undefined if the calling thread already owns the mutex (except if m is std::recursive_timed_mutex)

- The expression m.try_lock_until(time_point) has the following properties

  - Behaves as an atomic operation.
  - Attempts to obtain exclusive ownership of the mutex within the time left until `time_point`. If `time_point` already passed, attempts to obtain the ownership without locking (as if by `try_lock()`). Otherwise, this function blocks until the mutex is acquired or until the time specified by `time_point` passes. It returns before `time_point` only if it succeeds, but it allowed to fail to acquire the mutex even if at some point in time before `time_point` it was not owned by another thread. In any case, it returns true if the mutex was acquired and false otherwise.
  - If `try_lock_until(time_point)` succeeds, prior `unlock()` operations on the same object synchronize-with this operation (equivalent to release-acquire std::memory_order).
  - The behavior is undefined if the calling thread already owns the mutex (except if m is std::recursive_timed_mutex)

### [edit] Library types

The following standard library types satisfy `TimedMutex`:

- std::timed_mutex
- std::recursive_timed_mutex
- std::shared_mutex

### [edit] See also

- Thread support library
- `TimedLockable`
- `Mutex`

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/concept/TimedMutex&oldid=65577"