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.2 unique_­lock locking [thread.lock.unique.locking]

void lock();

1
#

Effects: As if by pm->lock().

2
#

Postconditions: owns == true.

3
#

Throws: Any exception thrown by pm->lock(). system_­error when an exception is required ([thread.req.exception]).

4
#

Error conditions:

  • (4.1)

    operation_­not_­permitted — if pm is nullptr.

  • (4.2)

    resource_­deadlock_­would_­occur — if on entry owns is true.

bool try_lock();

5
#

Requires: The supplied Mutex shall meet the Lockable requirements.

6
#

Effects: As if by pm->try_­lock().

7
#

Returns: The value returned by the call to try_­lock().

8
#

Postconditions: owns == res, where res is the value returned by the call to try_­lock().

9
#

Throws: Any exception thrown by pm->try_­lock(). system_­error when an exception is required ([thread.req.exception]).

10
#

Error conditions:

  • (10.1)

    operation_­not_­permitted — if pm is nullptr.

  • (10.2)

    resource_­deadlock_­would_­occur — if on entry owns is true.

template <class Clock, class Duration> bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);

11
#

Requires: The supplied Mutex type shall meet the TimedLockable requirements.

12
#

Effects: As if by pm->try_­lock_­until(abs_­time).

13
#

Returns: The value returned by the call to try_­lock_­until(abs_­time).

14
#

Postconditions: owns == res, where res is the value returned by the call to try_­lock_­until(abs_­time).

15
#

Throws: Any exception thrown by pm->try_­lock_­until(). system_­error when an exception is required ([thread.req.exception]).

16
#

Error conditions:

  • (16.1)

    operation_­not_­permitted — if pm is nullptr.

  • (16.2)

    resource_­deadlock_­would_­occur — if on entry owns is true.

template <class Rep, class Period> bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);

17
#

Requires: The supplied Mutex type shall meet the TimedLockable requirements.

18
#

Effects: As if by pm->try_­lock_­for(rel_­time).

19
#

Returns: The value returned by the call to try_­lock_­until(rel_­time).

20
#

Postconditions: owns == res, where res is the value returned by the call to try_­lock_­for(rel_­time).

21
#

Throws: Any exception thrown by pm->try_­lock_­for(). system_­error when an exception is required ([thread.req.exception]).

22
#

Error conditions:

  • (22.1)

    operation_­not_­permitted — if pm is nullptr.

  • (22.2)

    resource_­deadlock_­would_­occur — if on entry owns is true.

void unlock();

23
#

Effects: As if by pm->unlock().

24
#

Postconditions: owns == false.

25
#

Throws: system_­error when an exception is required ([thread.req.exception]).

26
#

Error conditions:

  • (26.1)

    operation_­not_­permitted — if on entry owns is false.