std::try_lock

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ(C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ(C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

ファイルシステムライブラリ(C++17)

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

技術仕様書

 

スレッドサポートライブラリ

スレッド
thread (C++11)
jthread (C++20)
stop_token (C++20)
stop_source (C++20)
stop_callback (C++20)
hardware_destructive_interference_sizehardware_constructive_interference_size (C++17)(C++17)
this_thread 名前空間
get_id (C++11) yield (C++11)	sleep_for (C++11) sleep_until (C++11)
相互排他
mutex (C++11) recursive_mutex (C++11) shared_mutex (C++17)	timed_mutex (C++11) recursive_timed_mutex (C++11) shared_timed_mutex (C++14)
汎用ロック管理
lock_guard (C++11) scoped_lock (C++17) unique_lock (C++11) shared_lock (C++14) defer_lock_ttry_to_lock_tadopt_lock_t (C++11)(C++11)(C++11)	lock (C++11) try_lock (C++11) defer_locktry_to_lockadopt_lock (C++11)(C++11)(C++11) once_flag (C++11) call_once (C++11)
条件変数
condition_variable (C++11)
condition_variable_any (C++11)
notify_all_at_thread_exit (C++11)
cv_status (C++11)
セマフォ
counting_semaphorebinary_semaphore (C++20)(C++20)
ラッチとバリア
latch (C++20)
barrier (C++20)
フューチャー
promise (C++11) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11)	launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (C++11)

 

ヘッダ <mutex> で定義
template<class Lockable1, class Lockable2, class... LockableN> int try_lock( Lockable1& lock1, Lockable2& lock2, LockableN&... lockn);		(C++11以上)

最初のものから開始して順に try_lock を呼ぶことによって、指定された Lockable なオブジェクト lock1, lock2, ..., lockn それぞれのロックを試みます。

try_lock の呼び出しが失敗した場合、それ以上の try_lock の呼び出しは行われず、ロックしたすべてのオブジェクトに対して unlock が呼ばれ、ロックに失敗したオブジェクトの 0 から始まるインデックスが返されます。

try_lock の呼び出しで例外が発生した場合、再スローの前にロックしたすべてのオブジェクトに対して unlock が呼ばれます。

引数

lock1, lock2, ... , lockn

-

ロックする Lockable なオブジェクト

戻り値

成功すれば -1、そうでなければロックに失敗したオブジェクトの 0 から始まるインデックスの値。

例

以下の例は異なるスレッドで実行しているカウンタの定期的な集計とリセットのために std::try_lock を使用します。

Run this code

#include <mutex>#include <vector>#include <thread>#include <iostream>#include <functional>#include <chrono>   int main(){int foo_count =0;std::mutex foo_count_mutex;int bar_count =0;std::mutex bar_count_mutex;int overall_count =0;bool done =false;std::mutex done_mutex;   auto increment =[](int&counter, std::mutex&m, constchar*desc){for(int i =0; i <10;++i){std::unique_lock<std::mutex> lock(m);++counter;std::cout<< desc <<": "<< counter <<'\n'; lock.unlock();std::this_thread::sleep_for(std::chrono::seconds(1));}};   std::thread increment_foo(increment, std::ref(foo_count), std::ref(foo_count_mutex), "foo");std::thread increment_bar(increment, std::ref(bar_count), std::ref(bar_count_mutex), "bar");   std::thread update_overall([&](){ done_mutex.lock();while(!done){ done_mutex.unlock();int result = std::try_lock(foo_count_mutex, bar_count_mutex);if(result ==-1){ overall_count += foo_count + bar_count; foo_count =0; bar_count =0;std::cout<<"overall: "<< overall_count <<'\n'; foo_count_mutex.unlock(); bar_count_mutex.unlock();}std::this_thread::sleep_for(std::chrono::seconds(2)); done_mutex.lock();} done_mutex.unlock();});   increment_foo.join(); increment_bar.join(); done_mutex.lock(); done =true; done_mutex.unlock(); update_overall.join();   std::cout<<"Done processing\n"<<"foo: "<< foo_count <<'\n'<<"bar: "<< bar_count <<'\n'<<"overall: "<< overall_count <<'\n';}

出力例:

bar: 1 foo: 1 foo: 2 bar: 2 foo: 3 overall: 5 bar: 1 foo: 1 bar: 2 foo: 2 bar: 3 overall: 10 bar: 1 foo: 1 bar: 2 foo: 2 overall: 14 bar: 1 foo: 1 bar: 2 overall: 17 foo: 1 bar: 1 foo: 2 overall: 20 Done processing foo: 0 bar: 0 overall: 20

関連項目

lock (C++11)

指定された複数のミューテックスをロックします。 いずれかが利用可能でなければブロックします (関数テンプレート)