cppdraft_translate/cppdraft/thread/lock/shared.md

[thread.lock.shared]

32 Concurrency support library [thread]

32.6 Mutual exclusion [thread.mutex]

32.6.5 Locks [thread.lock]

32.6.5.5 Class template shared_lock [thread.lock.shared]

32.6.5.5.1 General [thread.lock.shared.general]

🔗

namespace std {templateclass 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], lockingvoid lock(); // blockingbool 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], modifiersvoid swap(shared_lock& u) noexcept; mutex_type* release() noexcept; // [thread.lock.shared.obs], observersbool owns_lock() const noexcept; explicit operator bool() const noexcept; mutex_type* mutex() const noexcept; private: mutex_type* pm; // exposition onlybool owns; // exposition only};}

1

#

An object of type shared_lock controls the shared ownership of a lockable object within a scope.

Shared ownership of the lockable object may be acquired at construction or after construction, and may be transferred, after acquisition, to another shared_lock object.

Objects of typeshared_lock are not copyable but are movable.

The behavior of a program is undefined if the contained pointer pm is not null and the lockable object pointed to by pm does not exist for the entire remaining lifetime ([basic.life]) of the shared_lock object.

The suppliedMutex type shall meet the Cpp17SharedLockable requirements ([thread.req.lockable.shared]).

2

#

[Note 1:

shared_lock meets the Cpp17Lockable requirements ([thread.req.lockable.req]).

If Mutex meets the Cpp17SharedTimedLockable requirements ([thread.req.lockable.shared.timed]),shared_lock also meets the Cpp17TimedLockable requirements ([thread.req.lockable.timed]).

— end note]

32.6.5.5.2 Constructors, destructor, and assignment [thread.lock.shared.cons]

🔗

shared_lock() noexcept;

1

#

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

🔗

explicit shared_lock(mutex_type& m);

2

#

Effects: Calls m.lock_shared().

3

#

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

🔗

shared_lock(mutex_type& m, defer_lock_t) noexcept;

4

#

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

🔗

shared_lock(mutex_type& m, try_to_lock_t);

5

#

Effects: Calls m.try_lock_shared().

6

#

Postconditions: pm == addressof(m) and owns == res where res is the value returned by the call to m.try_lock_shared().

🔗

shared_lock(mutex_type& m, adopt_lock_t);

7

#

Preconditions: The calling thread holds a shared lock on m.

8

#

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

🔗

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

9

#

Preconditions: Mutex meets the Cpp17SharedTimedLockable requirements ([thread.req.lockable.shared.timed]).

10

#

Effects: Calls m.try_lock_shared_until(abs_time).

11

#

Postconditions: pm == addressof(m) and owns == res where res is the value returned by the call to m.try_lock_shared_until(abs_time).

🔗

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

12

#

Preconditions: Mutex meets the Cpp17SharedTimedLockable requirements ([thread.req.lockable.shared.timed]).

13

#

Effects: Calls m.try_lock_shared_for(rel_time).

14

#

Postconditions: pm == addressof(m) and owns == res where res is the value returned by the call to m.try_lock_shared_for(rel_time).

🔗

~shared_lock();

15

#

Effects: If owns calls pm->unlock_shared().

🔗

shared_lock(shared_lock&& sl) noexcept;

16

#

Postconditions: pm == sl_p.pm and owns == sl_p.owns (wheresl_p is the state of sl just prior to this construction),sl.pm == nullptr and sl.owns == false.

🔗

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

17

#

Effects: Equivalent to: shared_lock(std​::​move(sl)).swap(*this)

18

#

Returns: *this.

32.6.5.5.3 Locking [thread.lock.shared.locking]

🔗

void lock();

1

#

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

2

#

Postconditions: owns == true.

3

#

Throws: Any exception thrown by pm->lock_shared().

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 istrue.

🔗

bool try_lock();

5

#

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

6

#

Postconditions: owns == res, where res is the value returned by the call to pm->try_lock_shared().

7

#

Returns: The value returned by the call to pm->try_lock_shared().

8

#

Throws: Any exception thrown by pm->try_lock_shared().

system_error when an exception is required ([thread.req.exception]).

9

#

Error conditions:

• (9.1)

  operation_not_permitted — if pm is nullptr.

• (9.2)

  resource_deadlock_would_occur — if on entry owns istrue.

🔗

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

10

#

Preconditions: Mutex meets the Cpp17SharedTimedLockable requirements ([thread.req.lockable.shared.timed]).

11

#

Effects: As if by pm->try_lock_shared_until(abs_time).

12

#

Postconditions: owns == res, where res is the value returned by the call to pm->try_lock_shared_until(abs_time).

13

#

Returns: The value returned by the call topm->try_lock_shared_until(abs_time).

14

#

Throws: Any exception thrown by pm->try_lock_shared_until(abs_time).

system_error when an exception is required ([thread.req.exception]).

15

#

Error conditions:

• (15.1)

  operation_not_permitted — if pm is nullptr.

• (15.2)

  resource_deadlock_would_occur — if on entry owns istrue.

🔗

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

16

#

Preconditions: Mutex meets the Cpp17SharedTimedLockable requirements ([thread.req.lockable.shared.timed]).

17

#

Effects: As if by pm->try_lock_shared_for(rel_time).

18

#

Postconditions: owns == res, where res is the value returned by the call to pm->try_lock_shared_for(rel_time).

19

#

Returns: The value returned by the call to pm->try_lock_shared_for(rel_time).

20

#

Throws: Any exception thrown by pm->try_lock_shared_for(rel_time).

system_error when an exception is required ([thread.req.exception]).

21

#

Error conditions:

• (21.1)

  operation_not_permitted — if pm is nullptr.

• (21.2)

  resource_deadlock_would_occur — if on entry owns istrue.

🔗

void unlock();

22

#

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

23

#

Postconditions: owns == false.

24

#

Throws: system_error when an exception is required ([thread.req.exception]).

25

#

Error conditions:

• (25.1)

operation_not_permitted — if on entry owns isfalse.

32.6.5.5.4 Modifiers [thread.lock.shared.mod]

🔗

void swap(shared_lock& sl) noexcept;

1

#

Effects: Swaps the data members of *this and sl.

🔗

mutex_type* release() noexcept;

2

#

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

3

#

Returns: The previous value of pm.

🔗

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

4

#

Effects: As if by x.swap(y).

32.6.5.5.5 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.