RAII wrapper around POSIX threads with a modern C++ interface. More...

#include <pthread_wrapper.hpp>

Inheritance diagram for threadschedule::PThreadWrapper:

Public Types
using	native_handle_type = pthread_t
using	id = pthread_t

Public Member Functions
	PThreadWrapper ()
template<typename F, typename... Args>
	PThreadWrapper (F &&func, Args &&... args)
	PThreadWrapper (PThreadWrapper const &)=delete
auto	operator= (PThreadWrapper const &) -> PThreadWrapper &=delete
	PThreadWrapper (PThreadWrapper &&other) noexcept
auto	operator= (PThreadWrapper &&other) noexcept -> PThreadWrapper &
	~PThreadWrapper ()
void	join ()
void	detach ()
auto	joinable () const -> bool
auto	get_id () const -> id
auto	native_handle () const -> native_handle_type
auto	set_name (std::string const &name) const -> expected< void, std::error_code >
auto	get_name () const -> std::optional< std::string >
auto	set_priority (ThreadPriority priority) const -> expected< void, std::error_code >
auto	set_scheduling_policy (SchedulingPolicy policy, ThreadPriority priority) const -> expected< void, std::error_code >
auto	set_affinity (ThreadAffinity const &affinity) const -> expected< void, std::error_code >
auto	get_affinity () const -> std::optional< ThreadAffinity >
auto	cancel () const -> expected< void, std::error_code >

Static Public Member Functions
static auto	set_cancel_state (bool enabled) -> expected< void, std::error_code >
static auto	set_cancel_type (bool asynchronous) -> expected< void, std::error_code >
template<typename F, typename... Args>
static auto	create_with_config (std::string const &name, SchedulingPolicy policy, ThreadPriority priority, F &&f, Args &&... args) -> PThreadWrapper
template<typename F, typename... Args>
static auto	create_with_attributes (pthread_attr_t const &attr, F &&func, Args &&... args) -> PThreadWrapper

Detailed Description

RAII wrapper around POSIX threads with a modern C++ interface.

Linux-only - not available on Windows (guarded by _WIN32).

Non-copyable, movable. The destructor automatically joins the thread if it is still joinable, which blocks until the thread finishes.

Internally stores the callable in a heap-allocated std::function so that it can be passed through the C pthread_create API.

Note: Thread names are limited to 15 characters on Linux (enforced by pthread_setname_np).; cancel() sends a POSIX cancellation request to the thread. set_cancel_state() and set_cancel_type() are static and affect the calling thread, not the PThreadWrapper's thread.

Factory methods

create_with_config() - creates a thread and applies name/policy/priority.
create_with_attributes() - creates a thread from a raw pthread_attr_t.

See also: is_thread_like<PThreadWrapper> (specialised to true_type at end of file)

Definition at line 54 of file pthread_wrapper.hpp.

Member Typedef Documentation

◆ id

using threadschedule::PThreadWrapper::id = pthread_t

Definition at line 58 of file pthread_wrapper.hpp.

◆ native_handle_type

using threadschedule::PThreadWrapper::native_handle_type = pthread_t

Definition at line 57 of file pthread_wrapper.hpp.

Constructor & Destructor Documentation

◆ PThreadWrapper() [1/4]

threadschedule::PThreadWrapper::PThreadWrapper ( )

inline

Definition at line 60 of file pthread_wrapper.hpp.

Referenced by create_with_attributes(), create_with_config(), operator=(), operator=(), PThreadWrapper(), PThreadWrapper(), and threadschedule::PThreadWrapperReg::PThreadWrapperReg().

◆ PThreadWrapper() [2/4]

template<typename F, typename... Args>

threadschedule::PThreadWrapper::PThreadWrapper	(	F &&	func,
		Args &&...	args )

inlineexplicit

Definition at line 65 of file pthread_wrapper.hpp.

◆ PThreadWrapper() [3/4]

threadschedule::PThreadWrapper::PThreadWrapper ( PThreadWrapper const & )

delete

References PThreadWrapper().

◆ PThreadWrapper() [4/4]

threadschedule::PThreadWrapper::PThreadWrapper ( PThreadWrapper && other )

inlinenoexcept

Definition at line 87 of file pthread_wrapper.hpp.

References PThreadWrapper().

◆ ~PThreadWrapper()

threadschedule::PThreadWrapper::~PThreadWrapper ( )

inline

Definition at line 109 of file pthread_wrapper.hpp.

References join(), and joinable().

Member Function Documentation

◆ cancel()

auto threadschedule::PThreadWrapper::cancel ( ) const -> expected<void, std::error_code>

inlinenodiscard

Definition at line 189 of file pthread_wrapper.hpp.

◆ create_with_attributes()

template<typename F, typename... Args>

auto threadschedule::PThreadWrapper::create_with_attributes	(	pthread_attr_t const &	attr,
		F &&	func,
		Args &&...	args ) -> PThreadWrapper

inlinestatic

Definition at line 227 of file pthread_wrapper.hpp.

References PThreadWrapper().

◆ create_with_config()

template<typename F, typename... Args>

auto threadschedule::PThreadWrapper::create_with_config	(	std::string const &	name,
		SchedulingPolicy	policy,
		ThreadPriority	priority,
		F &&	f,
		Args &&...	args ) -> PThreadWrapper

inlinestatic

Definition at line 216 of file pthread_wrapper.hpp.

References PThreadWrapper(), set_name(), and set_scheduling_policy().

◆ detach()

void threadschedule::PThreadWrapper::detach ( )

inline

Definition at line 131 of file pthread_wrapper.hpp.

References joinable().

◆ get_affinity()

auto threadschedule::PThreadWrapper::get_affinity ( ) const -> std::optional<ThreadAffinity>

inlinenodiscard

Definition at line 183 of file pthread_wrapper.hpp.

References threadschedule::detail::read_affinity().

◆ get_id()

auto threadschedule::PThreadWrapper::get_id ( ) const -> id

inlinenodiscard

Definition at line 148 of file pthread_wrapper.hpp.

◆ get_name()

auto threadschedule::PThreadWrapper::get_name ( ) const -> std::optional<std::string>

inlinenodiscard

Definition at line 162 of file pthread_wrapper.hpp.

References threadschedule::detail::read_name().

◆ join()

void threadschedule::PThreadWrapper::join ( )

inline

Definition at line 118 of file pthread_wrapper.hpp.

References joinable().

Referenced by operator=(), and ~PThreadWrapper().

◆ joinable()

auto threadschedule::PThreadWrapper::joinable ( ) const -> bool

inlinenodiscard

Definition at line 143 of file pthread_wrapper.hpp.

Referenced by detach(), join(), operator=(), and ~PThreadWrapper().

◆ native_handle()

auto threadschedule::PThreadWrapper::native_handle ( ) const -> native_handle_type

inlinenodiscard

Definition at line 152 of file pthread_wrapper.hpp.

◆ operator=() [1/2]

auto threadschedule::PThreadWrapper::operator= ( PThreadWrapper && other ) -> PThreadWrapper&

inlinenoexcept

Definition at line 93 of file pthread_wrapper.hpp.

References join(), joinable(), and PThreadWrapper().

◆ operator=() [2/2]

auto threadschedule::PThreadWrapper::operator= ( PThreadWrapper const & ) -> PThreadWrapper &=delete

delete

References PThreadWrapper().

◆ set_affinity()

auto threadschedule::PThreadWrapper::set_affinity ( ThreadAffinity const & affinity ) const -> expected<void, std::error_code>

inlinenodiscard

Definition at line 178 of file pthread_wrapper.hpp.

References threadschedule::detail::apply_affinity().

◆ set_cancel_state()

auto threadschedule::PThreadWrapper::set_cancel_state ( bool enabled ) -> expected<void, std::error_code>

inlinestatic

Definition at line 196 of file pthread_wrapper.hpp.

◆ set_cancel_type()

auto threadschedule::PThreadWrapper::set_cancel_type ( bool asynchronous ) -> expected<void, std::error_code>

inlinestatic

Definition at line 205 of file pthread_wrapper.hpp.

◆ set_name()

auto threadschedule::PThreadWrapper::set_name ( std::string const & name ) const -> expected<void, std::error_code>

inlinenodiscard

Definition at line 157 of file pthread_wrapper.hpp.

References threadschedule::detail::apply_name().

Referenced by create_with_config().

◆ set_priority()

auto threadschedule::PThreadWrapper::set_priority ( ThreadPriority priority ) const -> expected<void, std::error_code>

inlinenodiscard

Definition at line 167 of file pthread_wrapper.hpp.

References threadschedule::detail::apply_priority().

◆ set_scheduling_policy()

auto threadschedule::PThreadWrapper::set_scheduling_policy	(	SchedulingPolicy	policy,
		ThreadPriority	priority ) const -> expected<void, std::error_code>

inlinenodiscard

Definition at line 172 of file pthread_wrapper.hpp.

References threadschedule::detail::apply_scheduling_policy().

Referenced by create_with_config().

The documentation for this class was generated from the following file:

pthread_wrapper.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ id

◆ native_handle_type

Constructor & Destructor Documentation

◆ PThreadWrapper() [1/4]

◆ PThreadWrapper() [2/4]

◆ PThreadWrapper() [3/4]

◆ PThreadWrapper() [4/4]

◆ ~PThreadWrapper()

Member Function Documentation

◆ cancel()

◆ create_with_attributes()

◆ create_with_config()

◆ detach()

◆ get_affinity()

◆ get_id()

◆ get_name()

◆ join()

◆ joinable()

◆ native_handle()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_affinity()

◆ set_cancel_state()

◆ set_cancel_type()

◆ set_name()

◆ set_priority()

◆ set_scheduling_policy()