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

#include <thread_backend.hpp>

Inheritance diagram for threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >:

Collaboration diagram for threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >:

Public Types
using	native_handle_type = typename ThreadType::native_handle_type

using	id = typename ThreadType::id

Public Member Functions
	basic_thread_backend ()=default

	basic_thread_backend (ThreadType &t)

	basic_thread_backend (ThreadType &t, native_thread_id tid)

virtual	~basic_thread_backend ()=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 -> expected< std::string, std::error_code >

auto	set_priority (native_thread_priority priority) -> expected< void, std::error_code >

auto	set_scheduling_policy (native_scheduling_policy policy, native_thread_priority priority) -> expected< void, std::error_code >

auto	configure (native_scheduling_config const &config) -> expected< void, std::error_code >

auto	set_nice_value (int nice_value) -> expected< void, std::error_code >

auto	get_nice_value () const -> expected< int, std::error_code >

auto	configure (native_thread_config const &config) -> expected< void, std::error_code >

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

auto	get_affinity () const -> expected< native_thread_affinity, std::error_code >

auto	native_id () const noexcept -> native_thread_id

Protected Member Functions
void	set_native_id (native_thread_id tid) noexcept

Static Protected Member Functions
static auto	no_such_thread () -> unexpected< std::error_code >

Protected Attributes
native_thread_id	native_id_ {}

Detailed Description

template<typename ThreadType, typename OwnershipTag = detail::owning_tag>
class threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >

Polymorphic base providing common thread management operations.

Template Parameters

ThreadType	The underlying thread type (std::thread or std::jthread).
OwnershipTag	detail::owning_tag (default) or detail::non_owning_tag.

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 (thread_backend and thread_view_backend) 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 or KernelBase.dll. Names may be longer. Returns errc::function_not_supported if the API is unavailable (pre-Windows 10 1607).

get_name(): Returns expected<std::string, std::error_code> so unavailable APIs, invalid handles, OS failures, and UTF conversion failures remain diagnosable.

set_priority(): Applies the regular portable priority model. On Linux this selects SCHED_OTHER and updates the thread's nice value. On Windows it 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(): Per-thread operation. On Linux, calls setpriority(PRIO_PROCESS, tid, ...) using the captured kernel TID. On Windows, maps to SetThreadPriority / GetThreadPriority without changing the process priority class.

Return Values: All set_* methods 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 255 of file thread_backend.hpp.

Member Typedef Documentation

◆ id

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

using threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::id = typename ThreadType::id

Definition at line 259 of file thread_backend.hpp.

◆ native_handle_type

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

using threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle_type = typename ThreadType::native_handle_type

Definition at line 258 of file thread_backend.hpp.

Constructor & Destructor Documentation

◆ basic_thread_backend() [1/3]

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

threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::basic_thread_backend ( )

default

◆ basic_thread_backend() [2/3]

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

threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::basic_thread_backend ( ThreadType & t )

inlineexplicit

Definition at line 262 of file thread_backend.hpp.

◆ basic_thread_backend() [3/3]

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

threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::basic_thread_backend	(	ThreadType &	t,
		native_thread_id	tid
	)

inline

Definition at line 263 of file thread_backend.hpp.

◆ ~basic_thread_backend()

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

virtual threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::~basic_thread_backend ( )

virtualdefault

Member Function Documentation

◆ configure() [1/2]

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::configure ( native_scheduling_config const & config ) -> expected<void, std::error_code>

inline

Definition at line 347 of file thread_backend.hpp.

References threadschedule::detail::apply_scheduling_config(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_, and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread().

Referenced by threadschedule::detail::thread_backend::create_with_config().

◆ configure() [2/2]

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::configure ( native_thread_config const & config ) -> expected<void, std::error_code>

inline

Definition at line 377 of file thread_backend.hpp.

References threadschedule::detail::configure_thread().

◆ detach()

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

void threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::detach ( )

inline

Definition at line 281 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_.

◆ get_affinity()

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::get_affinity ( ) const -> expected<native_thread_affinity, std::error_code>

inline

Definition at line 391 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread().

Referenced by threadschedule::thread::get_affinity().

◆ get_id()

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

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

inlinenoexcept

Definition at line 296 of file thread_backend.hpp.

Referenced by threadschedule::thread::get_id().

◆ get_name()

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::get_name ( ) const -> expected<std::string, std::error_code>

inline

Definition at line 317 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread().

Referenced by threadschedule::thread::get_name().

◆ get_nice_value()

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::get_nice_value ( ) const -> expected<int, std::error_code>

inline

Definition at line 369 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_, threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread(), and threadschedule::detail::read_effective_nice().

Referenced by threadschedule::thread::get_nice(), and threadschedule::thread::get_priority().

◆ join()

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

void threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::join ( )

inline

Definition at line 271 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_.

Referenced by threadschedule::detail::thread_backend::operator=(), and threadschedule::detail::scheduled_pool_backend_base< PoolType >::shutdown().

◆ joinable()

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

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

inlinenoexcept

Definition at line 291 of file thread_backend.hpp.

◆ native_handle()

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

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

inlinenoexcept

Definition at line 301 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable().

◆ native_id()

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id ( ) const -> native_thread_id

inlinenoexcept

Definition at line 399 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_.

◆ no_such_thread()

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

static auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread ( ) -> unexpected<std::error_code>

inlinestaticprotected

Definition at line 406 of file thread_backend.hpp.

◆ set_affinity()

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::set_affinity ( native_thread_affinity const & affinity ) -> expected<void, std::error_code>

inline

Definition at line 383 of file thread_backend.hpp.

References threadschedule::detail::apply_affinity_checked(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread().

◆ set_name()

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

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

inline

Definition at line 309 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread().

Referenced by threadschedule::detail::thread_backend::create_with_config(), and threadschedule::thread::set_name().

◆ set_native_id()

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

void threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::set_native_id ( native_thread_id tid )

inlineprotectednoexcept

Definition at line 412 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_.

◆ set_nice_value()

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::set_nice_value ( int nice_value ) -> expected<void, std::error_code>

inline

Definition at line 355 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_, and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread().

◆ set_priority()

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::set_priority ( native_thread_priority priority ) -> expected<void, std::error_code>

inline

Definition at line 325 of file thread_backend.hpp.

References threadschedule::detail::apply_scheduling_config(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_, threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread(), and threadschedule::detail::native_schedule::posix_nice().

◆ set_scheduling_policy()

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

auto threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::set_scheduling_policy	(	native_scheduling_policy	policy,
		native_thread_priority	priority
	)		-> expected<void, std::error_code>

inline

Definition at line 338 of file thread_backend.hpp.

References threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::joinable(), threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_handle(), and threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::no_such_thread().

Referenced by threadschedule::detail::thread_backend::create_with_config().

Member Data Documentation

◆ native_id_

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

native_thread_id threadschedule::detail::basic_thread_backend< ThreadType, OwnershipTag >::native_id_ {}

protected

Definition at line 420 of file thread_backend.hpp.

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

thread_backend.hpp

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ id

◆ native_handle_type

Constructor & Destructor Documentation

◆ basic_thread_backend() [1/3]

◆ basic_thread_backend() [2/3]

◆ basic_thread_backend() [3/3]

◆ ~basic_thread_backend()

Member Function Documentation

◆ configure() [1/2]

◆ configure() [2/2]

◆ detach()

◆ get_affinity()

◆ get_id()

◆ get_name()

◆ get_nice_value()

◆ join()

◆ joinable()

◆ native_handle()

◆ native_id()

◆ no_such_thread()

◆ set_affinity()

◆ set_name()

◆ set_native_id()

◆ set_nice_value()

◆ set_priority()

◆ set_scheduling_policy()

Member Data Documentation

◆ native_id_