mutex.hpp

Go to the documentation of this file.

#pragma once
#include "wait_handle.hpp"
#include "../date_time.hpp"
#include "../icomparable.hpp"
#include "../iequatable.hpp"

namespace xtd {
  namespace threading {
    class thread;
    
    class core_export_ mutex : public wait_handle, public icomparable<mutex>, public iequatable<mutex> {
      class mutex_base;
      class named_mutex;
      class unnamed_mutex;
    public:
      
      using native_handle_type = intptr;
      
      
      mutex();
      explicit mutex(bool initially_owned);
      explicit mutex(const string& name);
      mutex(const string& name, bool& created_new);
      mutex(bool initially_owned, const string& name);
      mutex(bool initially_owned, const string& name, bool& created_new);
      
      template<class char_t>
      explicit mutex(const char_t* name) : mutex(string(name)) {}
      ~mutex();
      
      
      [[nodiscard]] auto handle() const noexcept -> intptr override;
      auto handle(intptr value) -> void override;
      
      auto native_handle() const noexcept -> native_handle_type;
      
      
      auto close() -> void override;
      
      [[nodiscard]] auto compare_to(const mutex& value) const noexcept -> int32 override;
      
      [[nodiscard]] auto equals(const object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const mutex& other) const noexcept -> bool override;
      
      auto lock() -> void;
      
      auto release_mutex() -> void;
      
      [[nodiscard]] auto try_lock() noexcept -> bool;
      
      [[nodiscard]] auto try_lock_for(const time_span& timeout) noexcept -> bool;
      
      [[nodiscard]] auto try_lock_until(const date_time& timeout_time) noexcept -> bool;
      
      auto unlock() -> void;
      
      
      [[nodiscard]] static auto open_existing(const string& name) -> mutex;
      
      [[nodiscard]] static auto try_open_existing(const string& name, mutex& result) noexcept -> bool;
      
    protected:
      
      auto signal() -> bool override;
      
      auto wait(int32 milliseconds_timeout) -> bool override;
      
    private:
      friend class thread;
      auto create(bool initially_owned, bool& created_new) -> void;
      xtd::sptr<mutex_base> mutex_;
      string name_;
    };
  }
}