Polymorphic base providing common thread management operations. More...

#include <thread_wrapper.hpp>

Inheritance diagram for threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >:

Collaboration diagram for threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >:

Public Types
using	native_handle_type = typename ThreadType::native_handle_type
using	id = typename ThreadType::id

Public Member Functions
	BaseThreadWrapper ()=default
	BaseThreadWrapper (ThreadType &t)
virtual	~BaseThreadWrapper ()=default
void	join ()
void	detach ()
auto	joinable () const noexcept -> bool
auto	get_id () const noexcept -> id
auto	native_handle () noexcept -> native_handle_type
auto	set_name (std::string const &name) -> expected< void, std::error_code >
auto	get_name () const -> std::optional< std::string >
auto	set_priority (ThreadPriority priority) -> expected< void, std::error_code >
auto	set_scheduling_policy (SchedulingPolicy policy, ThreadPriority priority) -> expected< void, std::error_code >
auto	set_affinity (ThreadAffinity const &affinity) -> expected< void, std::error_code >
auto	get_affinity () const -> std::optional< ThreadAffinity >

Static Public Member Functions
static auto	set_nice_value (int nice_value) -> bool
static auto	get_nice_value () -> std::optional< int >

Detailed Description

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>
class threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >

Polymorphic base providing common thread management operations.

Template Parameters

ThreadType	The underlying thread type (std::thread or std::jthread).
OwnershipTag	detail::OwningTag (default) or detail::NonOwningTag.

Provides a uniform interface for join, detach, naming, priority, affinity, scheduling policy, and nice-value control on top of any standard thread type. Derived classes (ThreadWrapper, JThreadWrapper, and their View counterparts) customize ownership semantics while inheriting all of these operations.

Virtual Destructor: Has a virtual destructor so it can be used as a polymorphic base.

join() / detach(): Both are safe to call even if the thread is not joinable (they check first).

set_name()

Linux: uses pthread_setname_np; names are limited to 15 characters (returns errc::invalid_argument if exceeded).
Windows: dynamically loads SetThreadDescription from kernel32.dll. Names may be longer. Returns errc::function_not_supported if the API is unavailable (pre-Windows 10 1607).

set_priority(): Maps through SchedulerParams::create_for_policy(). On Linux, uses pthread_setschedparam and may require CAP_SYS_NICE or root privileges for real-time policies. On Windows, maps to SetThreadPriority constants.

set_scheduling_policy(): Linux-specific concept; on Windows this falls back to set_priority().

set_affinity()

Linux: pthread_setaffinity_np with cpu_set_t.
Windows: prefers SetThreadGroupAffinity (multi-processor-group aware) and falls back to SetThreadAffinityMask on single-group systems.

set_nice_value() / get_nice_value(): Process-level operation - affects all threads in the process. On Linux calls setpriority(PRIO_PROCESS, ...). On Windows maps to SetPriorityClass / GetPriorityClass.

Return Values: All set_* methods (except set_nice_value) return expected<void, std::error_code>. Always check the return value; failures are silent unless inspected.

Thread Safety: Individual method calls are safe if the underlying OS call is safe, but concurrent mutation of the same wrapper from multiple threads is not synchronized internally.

Definition at line 168 of file thread_wrapper.hpp.

Member Typedef Documentation

◆ id

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

using threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::id = typename ThreadType::id

Definition at line 172 of file thread_wrapper.hpp.

◆ native_handle_type

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

using threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::native_handle_type = typename ThreadType::native_handle_type

Definition at line 171 of file thread_wrapper.hpp.

Constructor & Destructor Documentation

◆ BaseThreadWrapper() [1/2]

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::BaseThreadWrapper ( )

default

Referenced by get_affinity(), and get_name().

◆ BaseThreadWrapper() [2/2]

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::BaseThreadWrapper ( ThreadType & t )

inlineexplicit

Definition at line 175 of file thread_wrapper.hpp.

◆ ~BaseThreadWrapper()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

virtual threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::~BaseThreadWrapper ( )

virtualdefault

Member Function Documentation

◆ detach()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

void threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::detach ( )

inline

Definition at line 189 of file thread_wrapper.hpp.

References joinable().

◆ get_affinity()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::get_affinity ( ) const -> std::optional<ThreadAffinity>

inlinenodiscard

Definition at line 236 of file thread_wrapper.hpp.

References BaseThreadWrapper(), native_handle(), and threadschedule::detail::read_affinity().

◆ get_id()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::get_id ( ) const -> id

inlinenodiscardnoexcept

Definition at line 201 of file thread_wrapper.hpp.

◆ get_name()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::get_name ( ) const -> std::optional<std::string>

inlinenodiscard

Definition at line 215 of file thread_wrapper.hpp.

References BaseThreadWrapper(), native_handle(), and threadschedule::detail::read_name().

◆ get_nice_value()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::get_nice_value ( ) -> std::optional<int>

inlinestatic

Definition at line 274 of file thread_wrapper.hpp.

◆ join()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

void threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::join ( )

inline

Definition at line 181 of file thread_wrapper.hpp.

References joinable().

◆ joinable()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::joinable ( ) const -> bool

inlinenodiscardnoexcept

Definition at line 197 of file thread_wrapper.hpp.

Referenced by detach(), and join().

◆ native_handle()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::native_handle ( ) -> native_handle_type

inlinenodiscardnoexcept

Definition at line 205 of file thread_wrapper.hpp.

Referenced by get_affinity(), get_name(), set_affinity(), set_name(), set_priority(), and set_scheduling_policy().

◆ set_affinity()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

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

inlinenodiscard

Definition at line 231 of file thread_wrapper.hpp.

References threadschedule::detail::apply_affinity(), and native_handle().

◆ set_name()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

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

inlinenodiscard

Definition at line 210 of file thread_wrapper.hpp.

References threadschedule::detail::apply_name(), and native_handle().

Referenced by threadschedule::ThreadWrapper::create_with_config().

◆ set_nice_value()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::set_nice_value ( int nice_value ) -> bool

inlinestatic

Definition at line 242 of file thread_wrapper.hpp.

◆ set_priority()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::set_priority ( ThreadPriority priority ) -> expected<void, std::error_code>

inlinenodiscard

Definition at line 220 of file thread_wrapper.hpp.

References threadschedule::detail::apply_priority(), and native_handle().

◆ set_scheduling_policy()

template<typename ThreadType, typename OwnershipTag = detail::OwningTag>

auto threadschedule::BaseThreadWrapper< ThreadType, OwnershipTag >::set_scheduling_policy	(	SchedulingPolicy	policy,
		ThreadPriority	priority ) -> expected<void, std::error_code>

inlinenodiscard

Definition at line 225 of file thread_wrapper.hpp.

References threadschedule::detail::apply_scheduling_policy(), and native_handle().

Referenced by threadschedule::ThreadWrapper::create_with_config().

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

thread_wrapper.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ id

◆ native_handle_type

Constructor & Destructor Documentation

◆ BaseThreadWrapper() [1/2]

◆ BaseThreadWrapper() [2/2]

◆ ~BaseThreadWrapper()

Member Function Documentation

◆ detach()

◆ get_affinity()

◆ get_id()

◆ get_name()

◆ get_nice_value()

◆ join()

◆ joinable()

◆ native_handle()

◆ set_affinity()

◆ set_name()

◆ set_nice_value()

◆ set_priority()

◆ set_scheduling_policy()