Namespaces
Variants

Standard library header <mutex> (C++11)

From cppreference.net
C++
Standard library headers

このヘッダは スレッドサポート ライブラリの一部です。

目次

クラス

(C++11)
基本的な相互排他機能を提供する
(class)
(C++11)
タイムアウト付きロックを実装する相互排他機能を提供する
(クラス)
(C++11)
同じスレッドによって再帰的にロック可能な相互排他機能を提供する
(クラス)
(C++11)
同じスレッドで再帰的にロック可能で、タイムアウト付きロックを実装する
相互排他機能を提供する
(class)
(C++11)
厳密なスコープベースのミューテックス所有権ラッパーを実装する
(クラステンプレート)
(C++11)
移動可能なミューテックス所有権ラッパーを実装する
(クラステンプレート)
(C++17)
デッドロック回避型の複数ミューテックス用RAIIラッパー
(クラステンプレート)
(C++11)
call_once が関数を一度だけ呼び出すことを保証するためのヘルパーオブジェクト
(クラス)

関数

(C++11)
ミューテックスの所有権を try_lock の繰り返し呼び出しによって取得しようと試みる
(関数テンプレート)
(C++11)
指定されたミューテックスをロックし、利用できない場合はブロックする
(関数テンプレート)
(C++11)
複数のスレッドから呼び出された場合でも、関数を一度だけ呼び出す
(関数テンプレート)
(C++11)
std::swap アルゴリズムを特殊化する
(関数テンプレート)

タグ

(C++11)
ロック戦略を指定するために使用されるタグ
(タグ)

概要 

namespace std {
  class mutex;
  class recursive_mutex;
  class timed_mutex;
  class recursive_timed_mutex;
  struct defer_lock_t { explicit defer_lock_t() = default; };
  struct try_to_lock_t { explicit try_to_lock_t() = default; };
  struct adopt_lock_t { explicit adopt_lock_t() = default; };
  inline constexpr defer_lock_t  defer_lock { };
  inline constexpr try_to_lock_t try_to_lock { };
  inline constexpr adopt_lock_t  adopt_lock { };
  template<class Mutex> class lock_guard;
  template<class... MutexTypes> class scoped_lock;
  template<class Mutex> class unique_lock;
  template<class Mutex>
    void swap(unique_lock<Mutex>& x, unique_lock<Mutex>& y) noexcept;
  template<class L1, class L2, class... L3> int try_lock(L1&, L2&, L3&...);
  template<class L1, class L2, class... L3> void lock(L1&, L2&, L3&...);
  struct once_flag;
  template<class Callable, class... Args>
    void call_once(once_flag& flag, Callable&& func, Args&&... args);
}

クラス std::mutex 

namespace std {
  class mutex {
  public:
    constexpr mutex() noexcept;
    ~mutex();
    mutex(const mutex&) = delete;
    mutex& operator=(const mutex&) = delete;
    void lock();
    bool try_lock();
    void unlock();
    using native_handle_type = /* implementation-defined */;
    native_handle_type native_handle();
  };
}

クラス std::recursive_mutex 

namespace std {
  class recursive_mutex {
  public:
    recursive_mutex();
    ~recursive_mutex();
    recursive_mutex(const recursive_mutex&) = delete;
    recursive_mutex& operator=(const recursive_mutex&) = delete;
    void lock();
    bool try_lock() noexcept;
    void unlock();
    using native_handle_type = /* implementation-defined */;
    native_handle_type native_handle();
  };
}

クラス std::timed_mutex 

namespace std {
  class timed_mutex {
  public:
    timed_mutex();
    ~timed_mutex();
    timed_mutex(const timed_mutex&) = delete;
    timed_mutex& operator=(const timed_mutex&) = delete;
    void lock();    // ブロッキング
    bool try_lock();
    template<class Rep, class Period>
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
    template<class Clock, class Duration>
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
    void unlock();
    using native_handle_type = /* 実装定義 */;
    native_handle_type native_handle();
  };
}

クラス std::recursive_timed_mutex 

namespace std {
  class recursive_timed_mutex {
  public:
    recursive_timed_mutex();
    ~recursive_timed_mutex();
    recursive_timed_mutex(const recursive_timed_mutex&) = delete;
    recursive_timed_mutex& operator=(const recursive_timed_mutex&) = delete;
    void lock();    // ブロッキング
    bool try_lock() noexcept;
    template<class Rep, class Period>
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
    template<class Clock, class Duration>
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
    void unlock();
    using native_handle_type = /* 実装定義 */;
    native_handle_type native_handle();
  };
}

クラステンプレート std::lock_guard 

namespace std {
  template<class Mutex>
  class lock_guard {
  public:
    using mutex_type = Mutex;
    explicit lock_guard(mutex_type& m);
    lock_guard(mutex_type& m, adopt_lock_t);
    ~lock_guard();
    lock_guard(const lock_guard&) = delete;
    lock_guard& operator=(const lock_guard&) = delete;
  private:
    mutex_type& pm;             // 説明専用
  };
}

クラステンプレート std:: scoped_lock 

namespace std {
  template<class... MutexTypes>
  class scoped_lock {
  public:
    using mutex_type = Mutex;   // MutexTypes... が単一の型 Mutex から構成される場合
    explicit scoped_lock(MutexTypes&... m);
    explicit scoped_lock(adopt_lock_t, MutexTypes&... m);
    ~scoped_lock();
    scoped_lock(const scoped_lock&) = delete;
    scoped_lock& operator=(const scoped_lock&) = delete;
  private:
    tuple<MutexTypes&...> pm;   // 説明専用
  };
}

クラステンプレート std::unique_lock 

namespace std {
  template<class Mutex>
  class unique_lock {
  public:
    using mutex_type = Mutex;
    // 構築/コピー/破棄
    unique_lock() noexcept;
    explicit unique_lock(mutex_type& m);
    unique_lock(mutex_type& m, defer_lock_t) noexcept;
    unique_lock(mutex_type& m, try_to_lock_t);
    unique_lock(mutex_type& m, adopt_lock_t);
    template<class Clock, class Duration>
      unique_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);
    template<class Rep, class Period>
      unique_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time);
    ~unique_lock();
    unique_lock(const unique_lock&) = delete;
    unique_lock& operator=(const unique_lock&) = delete;
    unique_lock(unique_lock&& u) noexcept;
    unique_lock& operator=(unique_lock&& u);
    // ロック操作
    void lock();
    bool try_lock();
    template<class Rep, class Period>
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
    template<class Clock, class Duration>
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
    void unlock();
    // 変更操作
    void swap(unique_lock& u) noexcept;
    mutex_type* release() noexcept;
    // 観測操作
    bool owns_lock() const noexcept;
    explicit operator bool () const noexcept;
    mutex_type* mutex() const noexcept;
  private:
    mutex_type* pm;             // 説明専用
    bool owns;                  // 説明専用
  };
  template<class Mutex>
    void swap(unique_lock<Mutex>& x, unique_lock<Mutex>& y) noexcept;
}

クラス std::once_flag 

namespace std {
  struct once_flag {
    constexpr once_flag() noexcept;
    once_flag(const once_flag&) = delete;
    once_flag& operator=(const once_flag&) = delete;
  };
}