aging_typed_job.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "typed_job.h"
#include "priority_aging_config.h"
 
#include <functional>
#include <string>
 
namespace kcenon::thread
{
    template <typename job_type>
    class aging_typed_job_t : public typed_job_t<job_type>
    {
    public:
        using base = typed_job_t<job_type>;
 
        aging_typed_job_t(job_type priority,
                          std::function<common::VoidResult()> work,
                          const std::string& name = "aging_job");
 
        ~aging_typed_job_t() override;
 
        // Non-copyable
        aging_typed_job_t(const aging_typed_job_t&) = delete;
        auto operator=(const aging_typed_job_t&) -> aging_typed_job_t& = delete;
 
        // Movable
        aging_typed_job_t(aging_typed_job_t&&) noexcept = default;
        auto operator=(aging_typed_job_t&&) noexcept -> aging_typed_job_t& = default;
 
        [[nodiscard]] auto do_work() -> common::VoidResult override;
 
        [[nodiscard]] auto get_aged_priority() const -> const aged_priority<job_type>&;
 
        [[nodiscard]] auto get_aged_priority() -> aged_priority<job_type>&;
 
        auto apply_boost(int boost_amount) -> void;
 
        auto reset_boost() -> void;
 
        auto set_max_boost(int max) -> void;
 
        [[nodiscard]] auto get_max_boost() const -> int;
 
        [[nodiscard]] auto is_max_boosted() const -> bool;
 
        [[nodiscard]] auto effective_priority() const -> job_type;
 
        [[nodiscard]] auto wait_time() const -> std::chrono::milliseconds;
 
        [[nodiscard]] auto to_job_info() const -> job_info;
 
    private:
        aged_priority<job_type> aged_priority_;
        int max_boost_{3};
        std::function<common::VoidResult()> work_;
    };
 
    using aging_typed_job = aging_typed_job_t<job_types>;
 
} // namespace kcenon::thread