std::mutex

 

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)

 

std::mutex

メンバ関数

mutex::mutex

mutex::~mutex

ロック

mutex::lock

mutex::try_lock

mutex::unlock

ネイティブハンドル

mutex::native_handle

 

<tbody> </tbody>

ヘッダ <mutex> で定義
class mutex;		(C++11以上)

mutex クラスは複数のスレッドによる同時アクセスから共有データを保護するために使用できる同期プリミティブです。

mutex は排他的で非再帰的な所有権のセマンティクスを提供します。

• 呼び出し元スレッドは、 lock または try_lock のいずれかを呼んで成功してから unlock を呼ぶまでの間、 mutex を所有します。
• スレッドが mutex を所有しているとき、他のすべてのスレッドは、 mutex の所有権の取得を試みた場合、 (lock の呼び出しに対して) ブロックされるか、 (try_lock に対して) false の戻り値を受け取ります。
• 呼び出し元スレッドは、 lock または try_lock を呼ぶとき、その mutex をすでに所有していてはなりません。

いずれかのスレッドによって未だ所有されている mutex を破棄したり、 mutex を所有しているスレッドが実行終了した場合、プログラムの動作は未定義です。 mutex クラスは Mutex および StandardLayoutType の要件をすべて満たします。

std::mutex はコピー可能でもムーブ可能でもありません。

メンバ型

メンバ型	定義
native_handle_type(オプション)	処理系定義

メンバ関数

コンストラクタ	ミューテックスを構築します (パブリックメンバ関数)
デストラクタ	ミューテックスを破棄します (パブリックメンバ関数)
operator= [削除]	コピー代入可能ではありません (パブリックメンバ関数)
ロック
lock	ミューテックスをロックします。 利用可能でない場合はブロックします (パブリックメンバ関数)
try_lock	ミューテックスのロックを試みます。 利用可能でない場合はリターンします (パブリックメンバ関数)
unlock	ミューテックスのロックを解除します (パブリックメンバ関数)
ネイティブハンドル
native_handle	処理系定義のベースとなるネイティブハンドルオブジェクトを返します (パブリックメンバ関数)

ノート

std::mutex は通常、直接アクセスしません。 std::unique_lock, std::lock_guard, または std::scoped_lock (C++17以上) を使用してより例外安全な方法でロックを管理します。

例

この例は2つのスレッド間で共有している std::map を保護するためにどのように mutex を使用できるかを示します。

Run this code

#include <iostream>
#include <map>
#include <string>
#include <chrono>
#include <thread>
#include <mutex>

std::map<std::string, std::string> g_pages;
std::mutex g_pages_mutex;

void save_page(const std::string &url)
{
    // ページの読み込みに時間がかかるのをシミュレートしています。
    std::this_thread::sleep_for(std::chrono::seconds(2));
    std::string result = "fake content";

    // ミューテックスをロックして g_pages にアクセスします。
    std::lock_guard<std::mutex> guard(g_pages_mutex);
    g_pages[url] = result;
}

int main() 
{
    std::thread t1(save_page, "http://foo");
    std::thread t2(save_page, "http://bar");
    t1.join();
    t2.join();

    // スレッドが join 済みであるため、ロックなしで g_pages にアクセスしても安全です。
    for (const auto &pair : g_pages) {
        std::cout << pair.first << " => " << pair.second << '\n';
    }
}

出力:

http://bar => fake content
http://foo => fake content