NUMA++ scheduler APIs. More...

Files
file	scheduler.hpp
	Contains scheduler declarations.

Classes
class	numapp::IdleScheduler
	Represents `SCHED_IDLE` scheduler policy. More...

class	numapp::StaticScheduler
	Static priority scheduler (real-time). More...

class	numapp::DynamicScheduler
	Normal non-realtime scheduler that use dynamic priority (nice value). More...

class	numapp::Scheduler
	A sum-type of all supported schedulers. More...

Typedefs
using	numapp::SchedulerVariant = std::variant<DynamicScheduler, StaticScheduler, IdleScheduler>
	Variant of possible schedulers.

Functions
std::ostream &	numapp::operator<< (std::ostream &os, SchedulerVariant const &scheduler)
	Formats scheduler and inserts it to os.

Apply Scheduler to Specified Thread
Applies scheduler to specified thread.
std::error_code	numapp::Apply (pid_t thread, IdleScheduler const &scheduler) noexcept
	Apply idle scheduler to specified thread.

std::error_code	numapp::Apply (pid_t thread, DynamicScheduler const &scheduler) noexcept
	Apply dynamic scheduler to specified thread.

std::error_code	numapp::Apply (pid_t thread, StaticScheduler const &scheduler) noexcept
	Apply static scheduler to specified thread.

std::error_code	numapp::Apply (pid_t thread, Scheduler const &scheduler) noexcept
	Apply variadic scheduler to specified thread.

std::error_code	Apply (pid_t thread, IdleScheduler const &scheduler) noexcept
	Apply idle scheduler to specified thread.

std::error_code	Apply (pid_t thread, DynamicScheduler const &scheduler) noexcept
	Apply dynamic scheduler to specified thread.

std::error_code	Apply (pid_t thread, StaticScheduler const &scheduler) noexcept
	Apply static scheduler to specified thread.

std::error_code	Apply (pid_t thread, Scheduler const &scheduler) noexcept
	Apply variadic scheduler to specified thread.

Apply Scheduler to Current Thread
Applies specified scheduler to current thread.
std::error_code	numapp::thisThread::Apply (IdleScheduler const &scheduler) noexcept
	Apply idle scheduler to this thread.

std::error_code	numapp::thisThread::Apply (DynamicScheduler const &scheduler) noexcept
	Apply dynamic scheduler to this thread.

std::error_code	numapp::thisThread::Apply (StaticScheduler const &scheduler) noexcept
	Apply static scheduler to this thread.

std::error_code	numapp::thisThread::Apply (Scheduler const &scheduler) noexcept
	Apply variadic scheduler to this thread.

std::error_code	Apply (IdleScheduler const &scheduler) noexcept
	Apply idle scheduler to this thread.

std::error_code	Apply (DynamicScheduler const &scheduler) noexcept
	Apply dynamic scheduler to this thread.

std::error_code	Apply (StaticScheduler const &scheduler) noexcept
	Apply static scheduler to this thread.

std::error_code	Apply (Scheduler const &scheduler) noexcept
	Apply variadic scheduler to this thread.

Detailed Description

NUMA++ scheduler APIs.

See Scheduler API for an overview.

Function Documentation

◆ Apply() [1/16]

std::error_code Apply	(	pid_t	thread,
		DynamicScheduler const &	scheduler )

nodiscardnoexcept

Apply dynamic scheduler to specified thread.

Parameters

thread	thread id.
scheduler	scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [2/16]

std::error_code Apply	(	pid_t	thread,
		IdleScheduler const &	scheduler )

nodiscardnoexcept

Apply idle scheduler to specified thread.

Parameters

thread	thread id.
scheduler	parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [3/16]

std::error_code Apply	(	pid_t	thread,
		Scheduler const &	scheduler )

nodiscardnoexcept

Apply variadic scheduler to specified thread.

Parameters

thread	thread id.
scheduler	parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [4/16]

std::error_code Apply	(	pid_t	thread,
		StaticScheduler const &	scheduler )

nodiscardnoexcept

Apply static scheduler to specified thread.

Parameters

thread	thread id.
scheduler	scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [5/16]

std::error_code Apply ( DynamicScheduler const & scheduler )

Apply dynamic scheduler to this thread.

Parameters

scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [6/16]

std::error_code Apply	(	pid_t	thread,
		DynamicScheduler const &	scheduler )

Apply dynamic scheduler to specified thread.

Parameters

thread	thread id.
scheduler	scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [7/16]

std::error_code Apply ( IdleScheduler const & scheduler )

Apply idle scheduler to this thread.

Parameters

scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [8/16]

std::error_code Apply	(	pid_t	thread,
		IdleScheduler const &	scheduler )

Apply idle scheduler to specified thread.

Parameters

thread	thread id.
scheduler	parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [9/16]

std::error_code Apply	(	pid_t	thread,
		Scheduler const &	scheduler )

Apply variadic scheduler to specified thread.

Parameters

thread	thread id.
scheduler	parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [10/16]

std::error_code Apply ( Scheduler const & scheduler )

Apply variadic scheduler to this thread.

Parameters

scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [11/16]

std::error_code Apply	(	pid_t	thread,
		StaticScheduler const &	scheduler )

Apply static scheduler to specified thread.

Parameters

thread	thread id.
scheduler	scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [12/16]

std::error_code Apply ( StaticScheduler const & scheduler )

Apply static scheduler to this thread.

Parameters

scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [13/16]

std::error_code numapp::thisThread::Apply ( DynamicScheduler const & scheduler )

nodiscardnoexcept

Apply dynamic scheduler to this thread.

Parameters

scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [14/16]

std::error_code numapp::thisThread::Apply ( IdleScheduler const & scheduler )

nodiscardnoexcept

Apply idle scheduler to this thread.

Parameters

scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [15/16]

std::error_code numapp::thisThread::Apply ( Scheduler const & scheduler )

nodiscardnoexcept

Apply variadic scheduler to this thread.

Parameters

scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ Apply() [16/16]

std::error_code numapp::thisThread::Apply ( StaticScheduler const & scheduler )

nodiscardnoexcept

Apply static scheduler to this thread.

Parameters

scheduler parameters.

Returns: 0 on success.; on-zero on failure.

◆ operator<<()

std::ostream & numapp::operator<<	(	std::ostream &	os,
		SchedulerVariant const &	scheduler )

Formats scheduler and inserts it to os.

Parameters

os	output stream to insert into.
scheduler	Scheduler to format.

Returns: os

Files

Classes

Typedefs

Functions

Apply Scheduler to Specified Thread

Apply Scheduler to Current Thread

Detailed Description

Function Documentation

◆ Apply() [1/16]

◆ Apply() [2/16]

◆ Apply() [3/16]

◆ Apply() [4/16]

◆ Apply() [5/16]

◆ Apply() [6/16]

◆ Apply() [7/16]

◆ Apply() [8/16]

◆ Apply() [9/16]

◆ Apply() [10/16]

◆ Apply() [11/16]

◆ Apply() [12/16]

◆ Apply() [13/16]

◆ Apply() [14/16]

◆ Apply() [15/16]

◆ Apply() [16/16]

◆ operator<<()