33 Thread support library [thread]

33.4 Mutual exclusion [thread.mutex]

33.4.4 Locks [thread.lock]

33.4.4.3 Class template unique_­lock [thread.lock.unique]

33.4.4.3.1 unique_­lock constructors, destructor, and assignment [thread.lock.unique.cons]

unique_lock() noexcept;
1
#
Effects: Constructs an object of type unique_­lock.
2
#
Postconditions: pm == 0 and owns == false.
explicit unique_lock(mutex_type& m);
3
#
Requires: If mutex_­type is not a recursive mutex the calling thread does not own the mutex.
4
#
Effects: Constructs an object of type unique_­lock and calls m.lock().
5
#
Postconditions: pm == addressof(m) and owns == true.
unique_lock(mutex_type& m, defer_lock_t) noexcept;
6
#
Effects: Constructs an object of type unique_­lock.
7
#
Postconditions: pm == addressof(m) and owns == false.
unique_lock(mutex_type& m, try_to_lock_t);
8
#
Requires: The supplied Mutex type shall meet the Lockable requirements ([thread.req.lockable.req]).
If mutex_­type is not a recursive mutex the calling thread does not own the mutex.
9
#
Effects: Constructs an object of type unique_­lock and calls m.try_­lock().
10
#
Postconditions: pm == addressof(m) and owns == res, where res is the value returned by the call to m.try_­lock().
unique_lock(mutex_type& m, adopt_lock_t);
11
#
Requires: The calling thread owns the mutex.
12
#
Effects: Constructs an object of type unique_­lock.
13
#
Postconditions: pm == addressof(m) and owns == true.
14
#
Throws: Nothing.
template <class Clock, class Duration> unique_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);
15
#
Requires: If mutex_­type is not a recursive mutex the calling thread does not own the mutex.
The supplied Mutex type shall meet the TimedLockable requirements ([thread.req.lockable.timed]).
16
#
Effects: Constructs an object of type unique_­lock and calls m.try_­lock_­until(abs_­time).
17
#
Postconditions: pm == addressof(m) and owns == res, where res is the value returned by the call to m.try_­lock_­until(abs_­time).
template <class Rep, class Period> unique_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time);
18
#
Requires: If mutex_­type is not a recursive mutex the calling thread does not own the mutex.
The supplied Mutex type shall meet the TimedLockable requirements ([thread.req.lockable.timed]).
19
#
Effects: Constructs an object of type unique_­lock and calls m.try_­lock_­for(rel_­time).
20
#
Postconditions: pm == addressof(m) and owns == res, where res is the value returned by the call to m.try_­lock_­for(rel_­time).
unique_lock(unique_lock&& u) noexcept;
21
#
Postconditions: pm == u_­p.pm and owns == u_­p.owns (where u_­p is the state of u just prior to this construction), u.pm == 0 and u.owns == false.
unique_lock& operator=(unique_lock&& u);
22
#
Effects: If owns calls pm->unlock().
23
#
Postconditions: pm == u_­p.pm and owns == u_­p.owns (where u_­p is the state of u just prior to this construction), u.pm == 0 and u.owns == false.
24
#
[ Note
:
With a recursive mutex it is possible for both *this and u to own the same mutex before the assignment.
In this case, *this will own the mutex after the assignment and u will not.
— end note
 ]
25
#
Throws: Nothing.
~unique_lock();
26
#
Effects: If owns calls pm->unlock().