threadschedule::ThreadControlBlock Class Reference

Per-thread control handle for OS-level scheduling operations. More...

#include <thread_registry.hpp>

Public Member Functions
	ThreadControlBlock ()=default
	ThreadControlBlock (ThreadControlBlock const &)=delete
auto	operator= (ThreadControlBlock const &) -> ThreadControlBlock &=delete
	ThreadControlBlock (ThreadControlBlock &&)=delete
auto	operator= (ThreadControlBlock &&) -> ThreadControlBlock &=delete
	~ThreadControlBlock ()
auto	tid () const noexcept -> Tid
auto	std_id () const noexcept -> std::thread::id
auto	set_affinity (ThreadAffinity const &affinity) const -> expected< void, std::error_code >
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_name (std::string const &name) const -> expected< void, std::error_code >

Static Public Member Functions
static auto	create_for_current_thread () -> std::shared_ptr< ThreadControlBlock >

Detailed Description

Per-thread control handle for OS-level scheduling operations.

A ThreadControlBlock captures the native thread handle (pthread_t on Linux, a duplicated HANDLE on Windows) at construction time and exposes cross-platform methods to modify the thread's affinity, priority, scheduling policy, and OS-visible name.

Creation

Always use the static factory create_for_current_thread(). It must be called from the thread it will represent, because it snapshots pthread_self() / GetCurrentThread().

Ownership

ThreadControlBlock is intended to be held via std::shared_ptr so that the registry, the owning thread, and any observers can all share the same instance. The static factory already returns a shared_ptr.

Thread safety

• The object is not copyable and not movable (identity type).
• All set_* methods are safe to call from any thread - they operate on the stored native handle, not on thread-local state.
• Concurrent calls to different set_* methods on the same instance are safe (each call is a single OS syscall on the stored handle).

Platform notes

• Linux: stores pthread_t obtained via pthread_self(). No resource is owned; the handle is valid for the lifetime of the thread.
• Windows: duplicates the pseudo-handle returned by GetCurrentThread() into a real HANDLE with THREAD_SET_INFORMATION | THREAD_QUERY_INFORMATION rights. The duplicated handle is closed in the destructor.

Caveats

• Do not construct directly; always use create_for_current_thread().
• On Linux, set_name() enforces the 15-character POSIX limit and returns std::errc::invalid_argument if exceeded.

Definition at line 134 of file thread_registry.hpp.

Constructor & Destructor Documentation

ThreadControlBlock() [1/3]

threadschedule::ThreadControlBlock::ThreadControlBlock ( )

default

Referenced by operator=(), operator=(), ThreadControlBlock(), and ThreadControlBlock().

ThreadControlBlock() [2/3]

threadschedule::ThreadControlBlock::ThreadControlBlock ( ThreadControlBlock const & )

delete

References ThreadControlBlock().

ThreadControlBlock() [3/3]

threadschedule::ThreadControlBlock::ThreadControlBlock ( ThreadControlBlock && )

delete

References ThreadControlBlock().

~ThreadControlBlock()

threadschedule::ThreadControlBlock::~ThreadControlBlock ( )

inline

Definition at line 143 of file thread_registry.hpp.

Member Function Documentation

create_for_current_thread()

auto threadschedule::ThreadControlBlock::create_for_current_thread ( ) -> std::shared_ptr<ThreadControlBlock>

inlinestatic

Definition at line 194 of file thread_registry.hpp.

References threadschedule::ThreadInfo::get_thread_id().

Referenced by threadschedule::AutoRegisterCurrentThread::AutoRegisterCurrentThread(), and threadschedule::AutoRegisterCurrentThread::AutoRegisterCurrentThread().

operator=() [1/2]

auto threadschedule::ThreadControlBlock::operator= ( ThreadControlBlock && ) -> ThreadControlBlock &=delete

delete

References ThreadControlBlock().

operator=() [2/2]

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

delete

References ThreadControlBlock().

set_affinity()

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

inlinenodiscard

Definition at line 173 of file thread_registry.hpp.

References threadschedule::detail::apply_affinity().

set_name()

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

inlinenodiscard

Definition at line 189 of file thread_registry.hpp.

References threadschedule::detail::apply_name().

set_priority()

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

inlinenodiscard

Definition at line 178 of file thread_registry.hpp.

References threadschedule::detail::apply_priority().

set_scheduling_policy()

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

inlinenodiscard

Definition at line 183 of file thread_registry.hpp.

References threadschedule::detail::apply_scheduling_policy().

std_id()

auto threadschedule::ThreadControlBlock::std_id ( ) const -> std::thread::id

inlinenodiscardnoexcept

Definition at line 158 of file thread_registry.hpp.

tid()

auto threadschedule::ThreadControlBlock::tid ( ) const -> Tid

inlinenodiscardnoexcept

Definition at line 154 of file thread_registry.hpp.

---

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

• thread_registry.hpp