callback_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"
 
namespace kcenon::thread
{
    template <typename job_type>
    class callback_typed_job_t : public typed_job_t<job_type>
    {
    public:
        callback_typed_job_t(const std::function<common::VoidResult(void)>& callback,
                            job_type priority,
                            const std::string& name = "typed_job");
 
        ~callback_typed_job_t(void) override;
 
        [[nodiscard]] auto do_work(void) -> common::VoidResult override;
 
    private:
        std::function<common::VoidResult(void)> callback_;
    };
 
    using callback_typed_job = callback_typed_job_t<job_types>;
 
    // Template definitions are provided in-header to support external priority types.
    template <typename job_type>
    callback_typed_job_t<job_type>::callback_typed_job_t(
        const std::function<common::VoidResult(void)>& callback,
        job_type priority,
        const std::string& name)
        : typed_job_t<job_type>(priority, name)
        , callback_(callback)
    {
    }
 
    template <typename job_type>
    callback_typed_job_t<job_type>::~callback_typed_job_t() = default;
 
    template <typename job_type>
    auto callback_typed_job_t<job_type>::do_work() -> common::VoidResult
    {
        if (!callback_)
        {
            return common::error_info{static_cast<int>(error_code::invalid_argument), "Callback is null", "thread_system"};
        }
 
        return callback_();
    }
 
    // Keep a single explicit instantiation for the default job_types in the .cpp translation unit.
    extern template class callback_typed_job_t<job_types>;
} // namespace kcenon::thread