std::mutex::lock - cppreference.com

From cppreference.com

voidlock();(since C++11)Locks the mutex. If another thread has already locked the mutex, a call to lock will block execution until the lock is acquired.

If lock is called by a thread that already owns the mutex, the behavior is undefined: for example, the program may deadlock. An implementation that can detect the invalid usage is encouraged to throw a

std::system_error

with error condition resource_deadlock_would_occur instead of deadlocking.

Prior

unlock()

operations on the same mutex synchronize-with (as defined in

std::memory_order

) this operation.

Parameters

(none)

Return value

(none)

Exceptions

Throws

std::system_error

when errors occur, including errors from the underlying operating system that would prevent lock from meeting its specifications. The mutex is not locked in the case of any exception being thrown.

Notes

lock() is usually not called directly:

std::unique_lock

,

std::scoped_lock

, and

std::lock_guard

are used to manage exclusive locking.

Example

This example shows how lock and unlock can be used to protect shared data.

Run this code

#include<chrono>#include<iostream>#include<mutex>#include<thread>intg_num=0;// protected by g_num_mutexstd::mutexg_num_mutex;voidslow_increment(intid){for(inti=0;i<3;++i){g_num_mutex.lock();++g_num;// note, that the mutex also syncronizes the outputstd::cout<<"id: "<<id<<", g_num: "<<g_num<<'\n';g_num_mutex.unlock();std::this_thread::sleep_for(std::chrono::milliseconds(234));}}intmain(){std::threadt1{slow_increment,0};std::threadt2{slow_increment,1};t1.join();t2.join();}Possible output:

id: 0, g_num: 1 id: 1, g_num: 2 id: 1, g_num: 3 id: 0, g_num: 4 id: 0, g_num: 5 id: 1, g_num: 6 See also