Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | header
m (link to ja)
m
Line 12: Line 12:
  
 
===Synopsis===
 
===Synopsis===
 
 
{{source|1=
 
{{source|1=
 
namespace std {
 
namespace std {
    class shared_mutex;
+
  class shared_mutex;
    class shared_timed_mutex;
+
  class shared_timed_mutex;
 
+
  template<class Mutex> class shared_lock;
    template <class Mutex> class shared_lock;
+
  template<class Mutex>
 
+
    template <class Mutex>
+
 
     void swap(shared_lock<Mutex>& x, shared_lock<Mutex>& y) noexcept;
 
     void swap(shared_lock<Mutex>& x, shared_lock<Mutex>& y) noexcept;
 
}
 
}
Line 27: Line 24:
 
====Class {{lc|std::shared_mutex}}====
 
====Class {{lc|std::shared_mutex}}====
 
{{source|1=
 
{{source|1=
class shared_mutex {
+
namespace std {
public:
+
  class shared_mutex {
    typedef /*implementation-defined*/ native_handle_type;
+
  public:
 
+
 
     shared_mutex();
 
     shared_mutex();
 
     ~shared_mutex();
 
     ~shared_mutex();
 +
 
     shared_mutex(const shared_mutex&) = delete;
 
     shared_mutex(const shared_mutex&) = delete;
 
     shared_mutex& operator=(const shared_mutex&) = delete;
 
     shared_mutex& operator=(const shared_mutex&) = delete;
  
     // Exclusive ownership
+
     // exclusive ownership
     void lock(); // blocking
+
     void lock();               // blocking
 
     bool try_lock();
 
     bool try_lock();
 
     void unlock();
 
     void unlock();
  
     // Shared ownership
+
     // shared ownership
     void lock_shared(); // blocking
+
     void lock_shared();         // blocking
 
     bool try_lock_shared();
 
     bool try_lock_shared();
 
     void unlock_shared();
 
     void unlock_shared();
  
     // Getters
+
     using native_handle_type = /* implementation-defined */;
 
     native_handle_type native_handle();
 
     native_handle_type native_handle();
};
+
  };
 +
}
 
}}
 
}}
  
 
====Class {{lc|std::shared_timed_mutex}}====
 
====Class {{lc|std::shared_timed_mutex}}====
 
{{source|1=
 
{{source|1=
class shared_timed_mutex {
+
namespace std {
public:
+
  class shared_timed_mutex {
 +
  public:
 
     shared_timed_mutex();
 
     shared_timed_mutex();
 
     ~shared_timed_mutex();
 
     ~shared_timed_mutex();
 +
 
     shared_timed_mutex(const shared_timed_mutex&) = delete;
 
     shared_timed_mutex(const shared_timed_mutex&) = delete;
 
     shared_timed_mutex& operator=(const shared_timed_mutex&) = delete;
 
     shared_timed_mutex& operator=(const shared_timed_mutex&) = delete;
  
     // Exclusive ownership
+
     // exclusive ownership
     void lock(); // blocking
+
     void lock();               // blocking
 
     bool try_lock();
 
     bool try_lock();
     template <class Rep, class Period>
+
     template<class Rep, class Period>
    bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
+
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
     template <class Clock, class Duration>
+
     template<class Clock, class Duration>
    bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
+
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
 
     void unlock();
 
     void unlock();
  
     // Shared ownership
+
     // shared ownership
     void lock_shared(); // blocking
+
     void lock_shared();         // blocking
 
     bool try_lock_shared();
 
     bool try_lock_shared();
     template <class Rep, class Period>
+
     template<class Rep, class Period>
    bool try_lock_shared_for(const chrono::duration<Rep, Period>& rel_time);
+
      bool try_lock_shared_for(const chrono::duration<Rep, Period>& rel_time);
     template <class Clock, class Duration>
+
     template<class Clock, class Duration>
    bool try_lock_shared_until(const chrono::time_point<Clock, Duration>& abs_time);
+
      bool try_lock_shared_until(const chrono::time_point<Clock, Duration>& abs_time);
 
     void unlock_shared();
 
     void unlock_shared();
};
+
  };
 +
}
 
}}
 
}}
  
====Class {{lc|std::shared_lock}}====
+
====Class template {{lc|std::shared_lock}}====
 
{{source|1=
 
{{source|1=
template <class Mutex>
+
namespace std {
class shared_lock {
+
  template<class Mutex>
public:
+
  class shared_lock {
     typedef Mutex mutex_type;
+
  public:
 +
     using mutex_type = Mutex;
  
 +
    // construct/copy/destroy
 
     shared_lock() noexcept;
 
     shared_lock() noexcept;
     explicit shared_lock(mutex_type& m); // blocking
+
     explicit shared_lock(mutex_type& m);       // blocking
 
     shared_lock(mutex_type& m, defer_lock_t) noexcept;
 
     shared_lock(mutex_type& m, defer_lock_t) noexcept;
 
     shared_lock(mutex_type& m, try_to_lock_t);
 
     shared_lock(mutex_type& m, try_to_lock_t);
 
     shared_lock(mutex_type& m, adopt_lock_t);
 
     shared_lock(mutex_type& m, adopt_lock_t);
     template <class Clock, class Duration>
+
     template<class Clock, class Duration>
    shared_lock(mutex_type& m,
+
      shared_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);
    const chrono::time_point<Clock, Duration>& abs_time);
+
     template<class Rep, class Period>
     template <class Rep, class Period>
+
      shared_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time);
    shared_lock(mutex_type& m,
+
    const chrono::duration<Rep, Period>& rel_time);
+
 
     ~shared_lock();
 
     ~shared_lock();
     shared_lock(shared_lock const&) = delete;
+
 
     shared_lock& operator=(shared_lock const&) = delete;
+
     shared_lock(const shared_lock&) = delete;
 +
     shared_lock& operator=(const shared_lock&) = delete;
 +
 
 
     shared_lock(shared_lock&& u) noexcept;
 
     shared_lock(shared_lock&& u) noexcept;
 
     shared_lock& operator=(shared_lock&& u) noexcept;
 
     shared_lock& operator=(shared_lock&& u) noexcept;
  
     void lock(); // blocking
+
    // locking
 +
     void lock();                               // blocking
 
     bool try_lock();
 
     bool try_lock();
     template <class Rep, class Period>
+
     template<class Rep, class Period>
    bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
+
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
     template <class Clock, class Duration>
+
     template<class Clock, class Duration>
    bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
+
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
 
     void unlock();
 
     void unlock();
  
     // Setters
+
     // [thread.lock.shared.mod], modifiers
 
     void swap(shared_lock& u) noexcept;
 
     void swap(shared_lock& u) noexcept;
 
     mutex_type* release() noexcept;
 
     mutex_type* release() noexcept;
  
     // Getters
+
     // observers
 
     bool owns_lock() const noexcept;
 
     bool owns_lock() const noexcept;
 
     explicit operator bool () const noexcept;
 
     explicit operator bool () const noexcept;
 
     mutex_type* mutex() const noexcept;
 
     mutex_type* mutex() const noexcept;
  
private:
+
  private:
     mutex_type* pm; // exposition only
+
     mutex_type* pm;                             // exposition only
     bool owns; // exposition only
+
     bool owns;                                 // exposition only
};
+
  };
 +
 
 +
  template<class Mutex>
 +
    void swap(shared_lock<Mutex>& x, shared_lock<Mutex>& y) noexcept;
 +
}
 
}}
 
}}
  
 
{{langlinks|ja|zh}}
 
{{langlinks|ja|zh}}

Revision as of 05:46, 17 July 2020

 
 
Standard library headers
 

This header is part of the thread support library.

Contents

Classes

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

Functions

specializes the std::swap algorithm
(function template) [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;
}

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();
  };
}

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();
  };
}

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();
 
    // [thread.lock.shared.mod], 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;
}