33 Thread support library [thread]

33.4 Mutual exclusion [thread.mutex]

33.4.4 Locks [thread.lock]

33.4.4.4 Class template shared_­lock [thread.lock.shared]

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

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

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

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

    // [thread.lock.shared.locking], locking
    void lock();  // blocking
    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.shared.mod], modifiers
    void swap(shared_lock& u) noexcept;
    mutex_type* release() noexcept;

    // [thread.lock.shared.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> shared_lock(shared_lock<Mutex>) -> shared_lock<Mutex>;

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

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

2
#

[  Note:shared_­lock<Mutex> соответствуетTimedLockable требованиям ([thread.req.lockable.timed]). ] — end note 

33.4.4.4.1 shared_­lock constructors, destructor, and assignment [thread.lock.shared.cons]

shared_lock() noexcept;

1
#

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

2
#

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

explicit shared_lock(mutex_type& m);

3
#

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

4
#

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

5
#

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

shared_lock(mutex_type& m, defer_lock_t) noexcept;

6
#

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

7
#

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

shared_lock(mutex_type& m, try_to_lock_t);

8
#

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

9
#

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

10
#

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

shared_lock(mutex_type& m, adopt_lock_t);

11
#

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

12
#

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

13
#

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

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

14
#

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

15
#

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

16
#

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

template <class Rep, class Period> shared_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time);

17
#

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

18
#

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

19
#

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

~shared_lock();

20
#

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

shared_lock(shared_lock&& sl) noexcept;

21
#

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

shared_lock& operator=(shared_lock&& sl) noexcept;

22
#

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

23
#

Postconditions:pm == sl_­p.pm иowns == sl_­p.owns (где sl_­p - состояниеsl непосредственно перед этим назначением), sl.pm == nullptr иsl.owns == false.

33.4.4.4.2 shared_­lock locking [thread.lock.shared.locking]

void lock();

1
#

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

2
#

Postconditions:owns == true.

3
#

Throws: Любое выброшенное исключениеpm->lock_­shared(). 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
#

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

6
#

Returns: Значение, возвращаемое вызовомpm->try_­lock_­shared().

7
#

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

8
#

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

9
#

Error conditions:

  • (9.1)

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

  • (9.2)

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

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

10
#

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

11
#

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

12
#

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

13
#

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

14
#

Error conditions:

  • (14.1)

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

  • (14.2)

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

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

15
#

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

16
#

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

17
#

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

18
#

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

19
#

Error conditions:

  • (19.1)

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

  • (19.2)

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

void unlock();

20
#

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

21
#

Postconditions:owns == false.

22
#

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

23
#

Error conditions:

  • (23.1)

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

33.4.4.4.3 shared_­lock modifiers [thread.lock.shared.mod]

void swap(shared_lock& sl) noexcept;

1
#

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

mutex_type* release() noexcept;

2
#

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

3
#

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

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

4
#

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

33.4.4.4.4 shared_­lock observers [thread.lock.shared.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.