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]

namespace std {
  template <class Mutex>
  class unique_lock {
  public:
    using mutex_type = Mutex;

    // [thread.lock.unique.cons], construct/copy/destroy
    unique_lock() noexcept;
    explicit unique_lock(mutex_type& m);
    unique_lock(mutex_type& m, defer_lock_t) noexcept;
    unique_lock(mutex_type& m, try_to_lock_t);
    unique_lock(mutex_type& m, adopt_lock_t);
    template <class Clock, class Duration>
      unique_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);
    template <class Rep, class Period>
      unique_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time);
    ~unique_lock();

    unique_lock(const unique_lock&) = delete;
    unique_lock& operator=(const unique_lock&) = delete;

    unique_lock(unique_lock&& u) noexcept;
    unique_lock& operator=(unique_lock&& u);

    // [thread.lock.unique.locking], locking
    void lock();
    bool try_lock();

    template <class Rep, class Period>
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
    template <class Clock, class Duration>
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);

    void unlock();

    // [thread.lock.unique.mod], modifiers
    void swap(unique_lock& u) noexcept;
    mutex_type* release() noexcept;

    // [thread.lock.unique.obs], observers
    bool owns_lock() const noexcept;
    explicit operator bool () const noexcept;
    mutex_type* mutex() const noexcept;

  private:
    mutex_type* pm; // exposition only
    bool owns;      // exposition only
  };

  template<class Mutex> unique_lock(unique_lock<Mutex>) -> unique_lock<Mutex>;

  template <class Mutex>
    void swap(unique_lock<Mutex>& x, unique_lock<Mutex>& y) noexcept;
}
1
#

Объект типаunique_­lock контролирует владение блокируемым объектом в области. Право собственности на запираемый объект может быть приобретено во время строительства или после строительства и может быть передано после приобретения другомуunique_­lock объекту. Объекты типаunique_­lock нельзя копировать, но можно перемещать. Поведение программы не определено , если содержащаяся указатель pm не является нулевым , и блокируемый объект , на который указываетpm не существует для всего оставшегося lifetime отunique_­lock объекта. Поставляемый Mutex тип должен соответствовать BasicLockable требованиям.

2
#

[  Note:unique_­lock<Mutex> соответствуетBasicLockable требованиям. ЕслиMutex соответствуетLockable требованиям, unique_­lock<Mutex> также соответствуетLockable требованиям; еслиMutex соответствуетTimedLockable требованиям, unique_­lock<Mutex> также соответствуетTimedLockable требованиям. ] — end note 

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

unique_lock() noexcept;

1
#

Effects: Создает объект типаunique_­lock.

2
#

Postconditions:pm == 0 иowns == false.

explicit unique_lock(mutex_type& m);

3
#

Requires: Еслиmutex_­type это не рекурсивный мьютекс, вызывающий поток не владеет мьютексом.

4
#

Effects: Создает объект типаunique_­lock и вызываетm.lock().

5
#

Postconditions:pm == addressof(m) иowns == true.

unique_lock(mutex_type& m, defer_lock_t) noexcept;

6
#

Effects: Создает объект типаunique_­lock.

7
#

Postconditions:pm == addressof(m) иowns == false.

unique_lock(mutex_type& m, try_to_lock_t);

8
#

Requires: ПоставляемыйMutex тип должен соответствовать Lockable требованиям. Еслиmutex_­type это не рекурсивный мьютекс, вызывающий поток не владеет мьютексом.

9
#

Effects: Создает объект типаunique_­lock и вызываетm.try_­lock().

10
#

Postconditions:pm == addressof(m) иowns == res, гдеres - значение, возвращаемое вызовомm.try_­lock().

unique_lock(mutex_type& m, adopt_lock_t);

11
#

Requires: Вызывающий поток владеет мьютексом.

12
#

Effects: Создает объект типаunique_­lock.

13
#

Postconditions:pm == addressof(m) иowns == true.

14
#

Throws: Ничего такого.

template <class Clock, class Duration> unique_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);

15
#

Requires: Еслиmutex_­type это не рекурсивный мьютекс, вызывающий поток не владеет мьютексом. ПоставляемыйMutex тип должен соответствовать TimedLockable требованиям.

16
#

Effects: Создает объект типаunique_­lock и вызываетm.try_­lock_­until(abs_­time).

17
#

Postconditions:pm == addressof(m) иowns == res, гдеres - значение, возвращаемое вызовом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: Еслиmutex_­type это не рекурсивный мьютекс, вызывающий поток не владеет мьютексом. ПоставляемыйMutex тип должен соответствоватьTimedLockable требованиям.

19
#

Effects: Создает объект типаunique_­lock и вызываетm.try_­lock_­for(rel_­time).

20
#

Postconditions:pm == addressof(m) иowns == res, гдеres - значение, возвращаемое вызовомm.try_­lock_­for(rel_­time).

unique_lock(unique_lock&& u) noexcept;

21
#

Postconditions:pm == u_­p.pm иowns == u_­p.owns (гдеu_­p - состояниеu непосредственно перед этой конструкцией),u.pm == 0 иu.owns == false.

unique_lock& operator=(unique_lock&& u);

22
#

Effects: Еслиowns звонитpm->unlock().

23
#

Postconditions:pm == u_­p.pm иowns == u_­p.owns (гдеu_­p - состояниеu непосредственно перед этой конструкцией),u.pm == 0 иu.owns == false.

24
#

[  Note: С рекурсивным мьютексом оба*this иu могут владеть одним и тем же мьютексом до назначения. В этом случае*this после присвоения мьютекс будет принадлежать иu не будет. ] — end note 

25
#

Throws: Ничего такого.

~unique_lock();

26
#

Effects: Еслиowns звонитpm->unlock().

33.4.4.3.2 unique_­lock locking [thread.lock.unique.locking]

void lock();

1
#

Effects: Как будто мимоpm->lock().

2
#

Postconditions:owns == true.

3
#

Throws: Любое выброшенное исключениеpm->lock().system_­error когда требуется исключение ([thread.req.exception]).

4
#

Error conditions:

  • (4.1)

    operation_­not_­permitted - еслиpm естьnullptr.

  • (4.2)

    resource_­deadlock_­would_­occur - если на входеowns естьtrue.

bool try_lock();

5
#

Requires: ПоставляемыйMutex должен соответствовать Lockable требованиям.

6
#

Effects: Как будто мимоpm->try_­lock().

7
#

Returns: Значение, возвращаемое вызовомtry_­lock().

8
#

Postconditions:owns == res, гдеres - значение, возвращаемое вызовомtry_­lock().

9
#

Throws: Любое выброшенное исключениеpm->try_­lock().system_­error когда требуется исключение ([thread.req.exception]).

10
#

Error conditions:

  • (10.1)

    operation_­not_­permitted - еслиpm естьnullptr.

  • (10.2)

    resource_­deadlock_­would_­occur - если на входеowns естьtrue.

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

11
#

Requires: ПоставляемыйMutex тип должен соответствовать TimedLockable требованиям.

12
#

Effects: Как будто мимоpm->try_­lock_­until(abs_­time).

13
#

Returns: Значение, возвращаемое вызовомtry_­lock_­until(abs_­time).

14
#

Postconditions:owns == res, гдеres - значение, возвращаемое вызовомtry_­lock_­until(abs_­time).

15
#

Throws: Любое выброшенное исключениеpm->try_­lock_­until().system_­error когда требуется исключение ([thread.req.exception]).

16
#

Error conditions:

  • (16.1)

    operation_­not_­permitted - еслиpm естьnullptr.

  • (16.2)

    resource_­deadlock_­would_­occur - если на входеowns есть true.

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

17
#

Requires: ПоставляемыйMutex тип должен соответствоватьTimedLockable требованиям.

18
#

Effects: Как будто мимоpm->try_­lock_­for(rel_­time).

19
#

Returns: Значение, возвращаемое вызовомtry_­lock_­until(rel_­time).

20
#

Postconditions:owns == res, гдеres - значение, возвращаемое вызовомtry_­lock_­for(rel_­time).

21
#

Throws: Любое выброшенное исключениеpm->try_­lock_­for().system_­error когда требуется исключение ([thread.req.exception]).

22
#

Error conditions:

  • (22.1)

    operation_­not_­permitted - еслиpm естьnullptr.

  • (22.2)

    resource_­deadlock_­would_­occur - если на входеowns есть true.

void unlock();

23
#

Effects: Как будто мимоpm->unlock().

24
#

Postconditions:owns == false.

25
#

Throws:system_­error когда требуется исключение ([thread.req.exception]).

26
#

Error conditions:

  • (26.1)

    operation_­not_­permitted - если на входеowns естьfalse.

33.4.4.3.3 unique_­lock modifiers [thread.lock.unique.mod]

void swap(unique_lock& u) noexcept;

1
#

Effects: Меняет местами элементы данных*this иu.

mutex_type* release() noexcept;

2
#

Returns: Предыдущее значениеpm.

3
#

Postconditions:pm == 0 иowns == false.

template <class Mutex> void swap(unique_lock<Mutex>& x, unique_lock<Mutex>& y) noexcept;

4
#

Effects: Как будто мимоx.swap(y).

33.4.4.3.4 unique_­lock observers [thread.lock.unique.obs]

bool owns_lock() const noexcept;

1
#

Returns:owns.

explicit operator bool() const noexcept;

2
#

Returns:owns.

mutex_type *mutex() const noexcept;

3
#

Returns:pm.