C++ concepts: TimedMutex

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

C++ concepts

Basic
DefaultConstructible CopyAssignable CopyConstructible	MoveAssignable (C++11) MoveConstructible (C++11) Destructible
Layout
TrivialType (C++11) TriviallyCopyable (C++11)	StandardLayoutType (C++11) PODType
Library-Wide
EqualityComparable LessThanComparable Swappable (C++11) ValueSwappable (C++11)	NullablePointer (C++11) Hash (C++11) Allocator
Container
Container SequenceContainer ReversibleContainer	AssociativeContainer AllocatorAwareContainer UnorderedAssociativeContainer (C++11)
Container Elements
DefaultInsertable (C++11) CopyInsertable (C++11) MoveInsertable (C++11)	EmplaceConstructible (C++11) Erasable (C++11)
Iterator
Iterator OutputIterator InputIterator	ForwardIterator BidirectionalIterator RandomAccessIterator ContiguousIterator (C++17)
Stream I/O
FormattedInputFunction UnformattedInputFunction	FormattedOutputFunction UnformattedOutputFunction
Random Numbers
SeedSequence (C++11) RandomNumberEngine (C++11)	RandomNumberDistribution (C++11) UniformRandomNumberGenerator (C++11) RandomNumberEngineAdaptor (C++11)
Concurrency
BasicLockable (C++11) Lockable (C++11) TimedLockable (C++11)	Mutex (C++11) TimedMutex (C++11) SharedMutex (C++14)
Other
CharTraits pos_type off_type Clock (C++11) BitmaskType	UnaryTypeTrait (C++11) BinaryTypeTrait (C++11) TransformationTrait (C++11) TrivialClock (C++11) LiteralType (C++11)

 

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

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)

Library types

The following standard library types satisfy TimedMutex:

• std::timed_mutex
• std::recursive_timed_mutex
• std::shared_mutex

See also

• Thread support library
• TimedLockable
• Mutex