Priority with aging support. More...

#include <priority_aging_config.h>

Inheritance diagram for kcenon::thread::aged_priority:

Collaboration diagram for kcenon::thread::aged_priority:

Public Member Functions
auto	effective_priority () const -> P
	Calculates the effective priority including boost.

auto	wait_time () const -> std::chrono::milliseconds
	Calculates the time this job has been waiting.

auto	apply_boost (int boost_amount, int max_boost) -> void
	Applies a boost to the priority.

auto	reset_boost () -> void
	Resets the boost to zero.

auto	is_max_boosted (int max_boost) const -> bool
	Checks if this job has reached max boost.

Public Attributes
P	base_priority
	The original priority level of the job.

int	boost {0}
	The current priority boost value.

std::chrono::steady_clock::time_point	enqueue_time
	The time when the job was enqueued.

Detailed Description

template<typename P>
struct kcenon::thread::aged_priority

Priority with aging support.

This structure wraps a base priority value with aging information, including the current boost level and enqueue time. It provides methods to calculate the effective priority and wait time.

Template Parameters

P	The base priority type (typically an enum or integral type).

Example Usage

aged_priority<job_types> ap{
    job_types::Background,  // base_priority
    0,                      // initial boost
    std::chrono::steady_clock::now()  // enqueue_time
};
 
// Apply boost
ap.apply_boost(1, 3);  // boost by 1, max 3
 
// Get effective priority
auto effective = ap.effective_priority();

Definition at line 174 of file priority_aging_config.h.

Member Function Documentation

◆ apply_boost()

template<typename P >

auto kcenon::thread::aged_priority< P >::apply_boost	(	int	boost_amount,
		int	max_boost ) -> void

inline

Applies a boost to the priority.

Parameters

boost_amount	The amount to boost.
max_boost	The maximum allowed boost.

Definition at line 233 of file priority_aging_config.h.

        {
            boost += boost_amount;
            if (boost > max_boost)
            {
                boost = max_boost;
            }
        }

References kcenon::thread::aged_priority::boost.

◆ effective_priority()

template<typename P >

auto kcenon::thread::aged_priority::effective_priority ( ) const -> P

inlinenodiscard

Calculates the effective priority including boost.

For enum types, the boost is subtracted from the enum value (lower enum value = higher priority). For integral types, the boost is added.

Returns: The effective priority value.

Definition at line 204 of file priority_aging_config.h.

        {
            // For enum types, lower values typically mean higher priority
            // Subtracting boost moves toward higher priority (lower enum value)
            auto base_value = static_cast<int>(base_priority);
            auto boosted_value = base_value - boost;
            // Clamp to valid range (minimum 0)
            boosted_value = (boosted_value < 0) ? 0 : boosted_value;
            return static_cast<P>(boosted_value);
        }

References kcenon::thread::aged_priority::base_priority, and kcenon::thread::aged_priority::boost.

◆ is_max_boosted()

template<typename P >

auto kcenon::thread::aged_priority::is_max_boosted ( int max_boost ) const -> bool

inlinenodiscard

Checks if this job has reached max boost.

Parameters

max_boost The maximum allowed boost.

Returns: true if boost equals max_boost.

Definition at line 256 of file priority_aging_config.h.

        {
            return boost >= max_boost;
        }

References kcenon::thread::aged_priority::boost.

Referenced by kcenon::thread::aging_typed_job_t< job_type >::is_max_boosted().

Here is the caller graph for this function:

◆ reset_boost()

template<typename P >

auto kcenon::thread::aged_priority::reset_boost ( ) -> void

inline

Resets the boost to zero.

Definition at line 245 of file priority_aging_config.h.

        {
            boost = 0;
        }

References kcenon::thread::aged_priority::boost.

◆ wait_time()

template<typename P >

auto kcenon::thread::aged_priority::wait_time ( ) const -> std::chrono::milliseconds

inlinenodiscard

Calculates the time this job has been waiting.

Returns: The wait time since enqueue.

Definition at line 220 of file priority_aging_config.h.

        {
            return std::chrono::duration_cast<std::chrono::milliseconds>(
                std::chrono::steady_clock::now() - enqueue_time
            );
        }