xtd 0.2.0
Loading...
Searching...
No Matches
semaphore.hpp
Go to the documentation of this file.
1
4#pragma once
6#include "wait_handle.hpp"
7#include "../icomparable.hpp"
8#include "../iequatable.hpp"
9#include "../int32_object.hpp"
10
12namespace xtd {
14 namespace threading {
38 class core_export_ semaphore : public wait_handle, public icomparable<semaphore>, public iequatable<semaphore> {
39 class semaphore_base;
40 class named_semaphore;
41 class unnamed_semaphore;
42 struct data;
43 public:
45
59 explicit semaphore(const string& name);
70 explicit semaphore(const string& name, bool& created_new);
76 explicit semaphore(int32 initial_count);
88 semaphore(int32 initial_count, const string& name);
101 semaphore(int32 initial_count, const string& name, bool& created_new);
109 semaphore(int32 initial_count, int32 maximum_count);
124 semaphore(int32 initial_count, int32 maximum_count, const string& name);
139 semaphore(int32 initial_count, int32 maximum_count, const string& name, bool& created_new);
141
143 template<class char_t>
144 explicit semaphore(const char_t* name) : semaphore(string(name)) {}
145 ~semaphore();
147
149
151 [[nodiscard]] auto handle() const noexcept -> intptr override;
152 auto handle(intptr value) -> void override;
154
156
158 auto close() -> void override;
159
160 [[nodiscard]] auto compare_to(const semaphore& value) const noexcept -> int32 override;
161
165 [[nodiscard]] auto equals(const object& obj) const noexcept -> bool override;
169 [[nodiscard]] auto equals(const semaphore& other) const noexcept -> bool override;
170
177 auto release() -> int32;
185 auto release(int32 release_count) -> int32;
187
189
199 [[nodiscard]] static auto open_existing(const string& name) -> semaphore;
200
208 [[nodiscard]] static auto try_open_existing(const string& name, semaphore& result) noexcept -> bool;
210
211 protected:
213
215 auto signal() -> bool override;
216
217 auto wait(int32 milliseconds_timeout) -> bool override;
219
220 private:
221 auto create(int32 initial_count, int32 maximum_count, bool& created_new) -> void;
222 xtd::sptr<semaphore_base> semaphore_;
223 xtd::sptr<data> data_;
224 };
225 }
226}
Defines a generalized comparison method that a value type or class implements to create a type-specif...
Definition icomparable.hpp:22
Defines a generalized method that a value type or class implements to create a type-specific method f...
Definition iequatable.hpp:23
Limits the number of threads that can access a resource or pool of resources concurrently.
Definition semaphore.hpp:38
semaphore(const string &name, bool &created_new)
Initializes a new instance of the xtd::threading::semaphore class, specifying optionally specifying t...
auto wait(int32 milliseconds_timeout) -> bool override
wait ownership of the specified mutex object.
semaphore(int32 initial_count, const string &name, bool &created_new)
Initializes a new instance of the xtd::threading::semaphore class, specifying the initial number of e...
auto equals(const object &obj) const noexcept -> bool override
Determines whether the specified object is equal to the current object.
semaphore(int32 initial_count, int32 maximum_count, const string &name, bool &created_new)
Initializes a new instance of the xtd::threading::semaphore class, specifying the initial number of e...
semaphore(int32 initial_count, int32 maximum_count, const string &name)
Initializes a new instance of the xtd::threading::semaphore class, specifying the initial number of e...
auto handle() const noexcept -> intptr override
Gets the native operating system handle.
semaphore(int32 initial_count, int32 maximum_count)
Initializes a new instance of the xtd::threading::semaphore class, specifying the initial number of e...
auto signal() -> bool override
Releases ownership of the specified wait_handle object.
semaphore(const string &name)
Initializes a new instance of the xtd::threading::semaphore class, specifying optionally specifying t...
semaphore()
Initializes a new instance of the xtd::threading::semaphore class.
semaphore(int32 initial_count, const string &name)
Initializes a new instance of the xtd::threading::semaphore class, specifying the initial number of e...
static auto open_existing(const string &name) -> semaphore
Opens the specified named semaphore, if it already exists.
semaphore(int32 initial_count)
Initializes a new instance of the xtd::threading::semaphore class, specifying the initial number of e...
static auto try_open_existing(const string &name, semaphore &result) noexcept -> bool
Opens the specified named semaphore, if it already exists, and returns a value that indicates whether...
auto release() -> int32
Exits the semaphore and returns the previous count.
auto close() -> void override
Releases all resources held by the current xtd::threading::wait_handle.
wait_handle()=default
Initializes a new instance of the xtd::threading::wait_handle class.
#define core_export_
Define shared library export.
Definition core_export.hpp:13
xtd::basic_string< char > string
Represents text as a sequence of UTF-8 code units.
Definition __string_definitions.hpp:43
xtd::shared_ptr_object< type_t > sptr
The xtd::sptr object is a shared pointer.
Definition sptr.hpp:25
std::intmax_t intptr
Represent a pointer or a handle.
Definition intptr.hpp:23
std::int32_t int32
Represents a 32-bit signed integer.
Definition int32.hpp:23
Contains xtd::icomparable interface.
Contains xtd::iequatable interface.
Contains xtd::int32_object alias.
The xtd::threading namespace provides classes and interfaces that enable multithreaded programming....
Definition abandoned_mutex_exception.hpp:10
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8
constexpr const_pointer data() const noexcept
Gets direct access to the underlying contiguous storage.
Definition read_only_span.hpp:201
Contains xtd::threading::semaphore_full_exception exception.
Contains xtd::threading::wait_handle class.