#include <thread.hpp>
Inheritance diagram for uvw::Thread:
Collaboration diagram for uvw::Thread:
Public Member Functions | |
| bool | run () noexcept |
| Creates a new thread. More... | |
| bool | run (Flags< Options > opts, std::size_t stack={}) noexcept |
| Creates a new thread. More... | |
| bool | join () noexcept |
| Joins with a terminated thread. More... | |
 Public Member Functions inherited from uvw::UnderlyingType< Thread, uv_thread_t > | |
| Loop & | loop () const noexcept |
| Gets the loop from which the resource was originated. More... | |
| const uv_thread_t * | raw () const noexcept |
| Gets the underlying raw data structure. More... | |
| uv_thread_t * | raw () noexcept |
| Gets the underlying raw data structure. More... | |
Static Public Member Functions | |
| static Type | self () noexcept |
| Obtains the identifier of the calling thread. More... | |
| static bool | equal (const Thread &tl, const Thread &tr) noexcept |
| Compares thread by means of their identifiers. More... | |
| Static Public Member Functions inherited from uvw::UnderlyingType< Thread, uv_thread_t > | |
| static std::shared_ptr< Thread > | create (Args &&... args) |
| Creates a new resource of the given type. More... | |
Detailed Description
The Thread wrapper.
To create a Thread through a Loop, arguments follow:
- A callback invoked to initialize thread execution. The type must be such that it can be assigned to an
std::function<void(std::shared_ptr<void>)>. - An optional payload the type of which is
std::shared_ptr<void>.
Definition at line 48 of file thread.hpp.
Member Function Documentation
◆ equal()
Compares thread by means of their identifiers.
- Parameters
-
tl A valid instance of a thread. tr A valid instance of a thread.
- Returns
- True if the two threads are the same thread, false otherwise.
Definition at line 79 of file thread.hpp.
◆ join()
|
inlinenoexcept |
Joins with a terminated thread.
- Returns
- True in case of success, false otherwise.
Definition at line 117 of file thread.hpp.
◆ run() [1/2]
|
inlinenoexcept |
Creates a new thread.
- Returns
- True in case of success, false otherwise.
Definition at line 91 of file thread.hpp.
◆ run() [2/2]
|
inlinenoexcept |
Creates a new thread.
Available flags are:
Thread::Options::THREAD_NO_FLAGS: no flags set.Thread::Options::THREAD_HAS_STACK_SIZE: if set,stackspecifies a stack size for the new thread. 0 indicates that the default value should be used (it behaves as if the flag was not set). Other values will be rounded up to the nearest page boundary.
- Returns
- True in case of success, false otherwise.
Definition at line 108 of file thread.hpp.
◆ self()
|
inlinestaticnoexcept |
Obtains the identifier of the calling thread.
- Returns
- The identifier of the calling thread.
Definition at line 69 of file thread.hpp.
The documentation for this class was generated from the following file:
- src/uvw/thread.hpp
