try_lock_shared.md

try_lock_shared

• shared_mutex[meta header]
• std[meta namespace]
• shared_mutex[meta class]
• function[meta id-type]
• cpp17[meta cpp]

bool try_lock_shared();

概要

共有ロックの取得を試みる。

要件

この関数を呼び出したスレッドが、ミューテックスの排他所有権と共有所有権のいずれもを保持していないこと。

効果

ブロッキングせずに、この関数を呼び出したスレッドがミューテックスの共有所有権を取得する

戻り値

共有所有権が取得できなかった場合は何もせずに関数がfalseで返り、共有所有権を取得できた場合はtrueを返す。

例外

投げない

備考

この関数の実装が、ミューテックスの所有権を保持しているスレッドがひとつもない場合でも、所有権の取得に失敗する可能性がある。

例

#include <thread>
#include <shared_mutex>

class X {
  mutable std::shared_mutex mtx_;
  int value_ = 0;
public:
  // メンバ変数value_への書き込みを排他的にする
  void add_value(int value)
  {
    mtx_.lock(); // 排他ロックを取得する
    value_ = value;
    mtx_.unlock(); // 排他ロックを手放す
  }

  // メンバ変数value_の値を読み込む
  int get_value() const
  {
    int result = 0;

    if (!mtx_.try_lock_shared()) { // 共有ロックの取得を試みる
      // 共有ロックの取得に失敗
      std::error_code ec(static_cast<int>(std::errc::device_or_resource_busy), std::generic_category());
      throw std::system_error(ec);
    }

    result = value_;
    mtx_.unlock_shared(); // 共有ロックを手放す
    return result;
  }
};

int main()
{
  X x;

  std::thread t1([&x]{ x.add_value(1); int value = x.get_value(); });
  std::thread t2([&x]{ x.add_value(2); int value = x.get_value(); });

  t1.join();
  t2.join();
}

• try_lock_shared()[color ff0000]
• lock()[link lock.md]
• unlock()[link unlock.md]
• unlock_shared()[link unlock_shared.md]
• std::errc::device_or_resource_busy[link /reference/system_error/errc.md]
• std::generic_category()[link /reference/system_error/generic_category.md]
• std::system_error[link /reference/system_error/system_error.md]

出力例

バージョン

言語

• C++17

処理系

• Clang: 3.7.1 [mark verified]
• GCC: 6.3 [mark verified]
• ICC: ??
• Visual C++: ??