std::unique_lock::lock

From cppreference.com
void lock();
(since C++11)

Locks the associated mutex. Effectively calls mutex()->lock().

std::system_error is thrown if there is no associated mutex or if the mutex is already locked.

Contents

[edit] Parameters

(none)

[edit] Return value

(none)

[edit] Exceptions

  • Any exceptions thrown by mutex()->lock()
  • If there is no associated mutex, std::system_error with an error code of std::errc::operation_not_permitted
  • If the mutex is already locked, std::system_error with an error code of std::errc::resource_deadlock_would_occur

[edit] Example

[edit] See also

tries to lock the associated mutex, returns if the mutex is not available
(public member function)
unlocks the associated mutex
(public member function)