Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/header/shared mutex"

From cppreference.com
< cpp‎ | header
m (move)
(move synopsis to template)
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
{{cpp/header/title|shared_mutex}}
+
{{cpp/header/title|shared_mutex|notes={{mark c++14}}}}
 
{{cpp/header/navbar}}
 
{{cpp/header/navbar}}
 
This header is part of the [[cpp/thread|thread support]] library.
 
This header is part of the [[cpp/thread|thread support]] library.
 
{{dsc begin}}
 
{{dsc begin}}
 
{{dsc h1|Classes}}
 
{{dsc h1|Classes}}
 +
{{dsc inc | cpp/thread/dsc shared_mutex}}
 
{{dsc inc | cpp/thread/dsc shared_timed_mutex}}
 
{{dsc inc | cpp/thread/dsc shared_timed_mutex}}
 
{{dsc inc | cpp/thread/dsc shared_lock}}
 
{{dsc inc | cpp/thread/dsc shared_lock}}
Line 11: Line 12:
  
 
===Synopsis===
 
===Synopsis===
 +
{{cpp/synopsis/shared_mutex}}
  
−
{{source|1=
+
{{langlinks|es|ja|zh}}
−
namespace std {
+
−
    class shared_timed_mutex;
+
−
 
+
−
    template <class Mutex> class shared_lock;
+
−
 
+
−
    template <class Mutex>
+
−
    void swap(shared_lock<Mutex>& x, shared_lock<Mutex>& y) noexcept;
+
−
}
+
−
}}
+
−
 
+
−
====Class {{lc|std::shared_timed_mutex}}====
+
−
{{source|1=
+
−
class shared_timed_mutex {
+
−
public:
+
−
    shared_timed_mutex();
+
−
    ~shared_timed_mutex();
+
−
    shared_timed_mutex(const shared_timed_mutex&) = delete;
+
−
    shared_timed_mutex& operator=(const shared_timed_mutex&) = delete;
+
−
 
+
−
    // Exclusive ownership
+
−
    void lock(); // blocking
+
−
    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();
+
−
 
+
−
    // Shared ownership
+
−
    void lock_shared(); // blocking
+
−
    bool try_lock_shared();
+
−
    template <class Rep, class Period>
+
−
    bool try_lock_shared_for(const chrono::duration<Rep, Period>& rel_time);
+
−
    template <class Clock, class Duration>
+
−
    bool try_lock_shared_until(const chrono::time_point<Clock, Duration>& abs_time);
+
−
    void unlock_shared();
+
−
};
+
−
}}
+
−
 
+
−
====Class {{lc|std::shared_lock}}====
+
−
{{source|1=
+
−
template <class Mutex>
+
−
class shared_lock {
+
−
public:
+
−
    typedef Mutex mutex_type;
+
−
 
+
−
    shared_lock() noexcept;
+
−
    explicit shared_lock(mutex_type& m); // blocking
+
−
    shared_lock(mutex_type& m, defer_lock_t) noexcept;
+
−
    shared_lock(mutex_type& m, try_to_lock_t);
+
−
    shared_lock(mutex_type& m, adopt_lock_t);
+
−
    template <class Clock, class Duration>
+
−
    shared_lock(mutex_type& m,
+
−
    const chrono::time_point<Clock, Duration>& abs_time);
+
−
    template <class Rep, class Period>
+
−
    shared_lock(mutex_type& m,
+
−
    const chrono::duration<Rep, Period>& rel_time);
+
−
    ~shared_lock();
+
−
    shared_lock(shared_lock const&) = delete;
+
−
    shared_lock& operator=(shared_lock const&) = delete;
+
−
    shared_lock(shared_lock&& u) noexcept;
+
−
    shared_lock& operator=(shared_lock&& u) noexcept;
+
−
 
+
−
    void lock(); // blocking
+
−
    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();
+
−
 
+
−
    // Setters
+
−
    void swap(shared_lock& u) noexcept;
+
−
    mutex_type* release() noexcept;
+
−
 
+
−
    // Getters
+
−
    bool owns_lock() const noexcept;
+
−
    explicit operator bool () const noexcept;
+
−
    mutex_type* mutex() const noexcept;
+
−
 
+
−
private:
+
−
    mutex_type* pm; // exposition only
+
−
    bool owns; // exposition only
+
−
};
+
−
}}
+

Latest revision as of 07:18, 27 November 2023

 
C++
 
Standard library headers
 

This header is part of the thread support library.

Contents

Classes

(C++17)
 provides shared mutual exclusion facility
(class) [edit]
(C++14)
 provides shared mutual exclusion facility and implements locking with a timeout
(class) [edit]
(C++14)
 implements movable shared mutex ownership wrapper
(class template) [edit]

Functions

(C++14)
 specializes the std::swap algorithm
(function template) [edit]

[edit] Synopsis

namespace std {
  class shared_mutex;
  class shared_timed_mutex;
  template<class Mutex> class shared_lock;
  template<class Mutex>
    void swap(shared_lock<Mutex>& x, shared_lock<Mutex>& y) noexcept;
}

[edit] Class std::shared_mutex

namespace std {
  class shared_mutex {
  public:
    shared_mutex();
    ~shared_mutex();
 
    shared_mutex(const shared_mutex&) = delete;
    shared_mutex& operator=(const shared_mutex&) = delete;
 
    // exclusive ownership
    void lock();                // blocking
    bool try_lock();
    void unlock();
 
    // shared ownership
    void lock_shared();         // blocking
    bool try_lock_shared();
    void unlock_shared();
 
    using native_handle_type = /* implementation-defined */;
    native_handle_type native_handle();
  };
}

[edit] Class std::shared_timed_mutex

namespace std {
  class shared_timed_mutex {
  public:
    shared_timed_mutex();
    ~shared_timed_mutex();
 
    shared_timed_mutex(const shared_timed_mutex&) = delete;
    shared_timed_mutex& operator=(const shared_timed_mutex&) = delete;
 
    // exclusive ownership
    void lock();                // blocking
    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();
 
    // shared ownership
    void lock_shared();         // blocking
    bool try_lock_shared();
    template<class Rep, class Period>
      bool try_lock_shared_for(const chrono::duration<Rep, Period>& rel_time);
    template<class Clock, class Duration>
      bool try_lock_shared_until(const chrono::time_point<Clock, Duration>& abs_time);
    void unlock_shared();
  };
}

[edit] Class template std::shared_lock

namespace std {
  template<class Mutex>
  class shared_lock {
  public:
    using mutex_type = Mutex;
 
    // construct/copy/destroy
    shared_lock() noexcept;
    explicit shared_lock(mutex_type& m);        // blocking
    shared_lock(mutex_type& m, defer_lock_t) noexcept;
    shared_lock(mutex_type& m, try_to_lock_t);
    shared_lock(mutex_type& m, adopt_lock_t);
    template<class Clock, class Duration>
      shared_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);
    template<class Rep, class Period>
      shared_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time);
    ~shared_lock();
 
    shared_lock(const shared_lock&) = delete;
    shared_lock& operator=(const shared_lock&) = delete;
 
    shared_lock(shared_lock&& u) noexcept;
    shared_lock& operator=(shared_lock&& u) noexcept;
 
    // locking
    void lock();                                // blocking
    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();
 
    // modifiers
    void swap(shared_lock& u) noexcept;
    mutex_type* release() noexcept;
 
    // observers
    bool owns_lock() const noexcept;
    explicit operator bool () const noexcept;
    mutex_type* mutex() const noexcept;
 
  private:
    mutex_type* pm;                             // exposition only
    bool owns;                                  // exposition only
  };
 
  template<class Mutex>
    void swap(shared_lock<Mutex>& x, shared_lock<Mutex>& y) noexcept;
}
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/header/shared_mutex&oldid=163986"