try_lock.md

try_lock

• mutex[meta header]
• std[meta namespace]
• recursive_mutex[meta class]
• function[meta id-type]
• cpp11[meta cpp]

bool try_lock();

概要

ロックの取得を試みる

効果

ブロッキングせずに、この関数を呼び出したスレッドがミューテックスの所有権を取得する。この関数を呼び出したスレッドが新たに所有権を取得した場合は、所有権カウントを1とする。すでにミューテックスの所有権を保持していた場合は、所有権カウントを1増加する。

戻り値

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

例外

投げない

備考

あるスレッドが再帰的に所有権を取得可能な最大回数（所有権カウントの上限値）は、規定されていない。所有権カウントの上限値に達している場合、所有権を取得済みのスレッドであってもfalseを返す（このとき所有権カウントの増加は行われない）。

例

#include <iostream>
#include <mutex>
#include <thread>
#include <system_error>

class counter {
  int count_ = 0;
  std::recursive_mutex mtx_;
public:
  int add(int value)
  {
    if (!mtx_.try_lock()) {
      // ロックの取得に失敗
      std::error_code ec(static_cast<int>(std::errc::device_or_resource_busy), std::generic_category());
      throw std::system_error(ec);
    }
    int result = count_ += value;
    mtx_.unlock();
    return result;
  }

  int increment()
  {
    if (!mtx_.try_lock()) { // ロックを取得する
      // ロックの取得に失敗
      std::error_code ec(static_cast<int>(std::errc::device_or_resource_busy), std::generic_category());
      throw std::system_error(ec);
    }
    int result = add(1); // add()関数内でも同じミューテックスからロックを取得する
    mtx_.unlock();
    return result;
  }
};

std::mutex print_mtx_;
void print_value(int value)
{
  std::lock_guard<std::mutex> lock(print_mtx_);
  std::cout << "count == " << value << std::endl;
}

counter c;
void change_count()
{
  int value = c.increment();
  print_value(value);
}

int main()
{
  std::thread t1(change_count);
  std::thread t2(change_count);

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

• try_lock[color ff0000]
• mtx_.unlock()[link unlock.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]

出力例

count == 1
count == 2

バージョン

言語

• C++11

処理系

• Clang: ??
• GCC: 4.7.0 [mark verified]
• ICC: ??
• Visual C++: 2012 [mark verified], 2013 [mark verified], 2015 [mark verified]

参照