threadpool.hpp

Go to the documentation of this file.

//==================================================================================================
/// \file
/// This header-file is part of \dxl - A doxygen post-processor that allows to define smarter
/// <b>Doxygen</b>-links.
///
/// \emoji :copyright: 2025-2026 A-Worx GmbH, Germany.
/// Published under \ref mainpage_license "Boost Software License".
//==================================================================================================
#ifndef HPP_DXL_THREADPOOL
#define HPP_DXL_THREADPOOL
#pragma once
#include "mappedfile.hpp"
#include "ALib.ThreadModel.H"
 
namespace dxl {
struct DXLPoolWorker;
class  DXLThreadPool;
 
/// The base class \dxl-jobs.
struct DXLJob : alib::threadmodel::Job {
    using Job::Job;
    DXLPoolWorker*  poolWorker; ///< The pool worker that executes this job.
};
 
 
/// A customized \alib thread-pool worker.
struct DXLPoolWorker : alib::threadmodel::PoolWorker {
    /// A mono allocator. This is reset with every job execution.
    alib::MonoAllocator     TMA;
 
    /// A read buffer. This is never shrunk but growing each time a larger file is loaded.
    MappedFile              InputFile;
 
    /// A write buffer. This is never shrunk but growing each time a larger file is written.
    alib::AString           WriteBuffer; ///< A buffer
 
    /// Constructor
    /// @param pool The pool we belong to.
    /// @param pName This worker's name.
    DXLPoolWorker(DXLThreadPool& pool, const alib::character* pName);
 
    /// Attaches a pointer to ourselves to the Job.
    ///@param job The job to prepare.
    virtual void PrepareJob(alib::threadmodel::Job* job)  override {
        dynamic_cast<DXLJob*>(job)->poolWorker= this;
        TMA        .Reset();
        WriteBuffer.Reset();
    }
 
};
 
/// A customized \alib thread-pool.
class DXLThreadPool : public alib::threadmodel::ThreadPool {
 
    /// Creates a custom worker of type #"DXLPoolWorker".
    /// @return A pool worker.
    alib::threadmodel::PoolWorker* CreateWorker() override {
        return pool().New<DXLPoolWorker>( *this,  alib::String128("DXLPoolWorker")
                                                        << alib::Dec(nextWorkerID++, 3, nullptr) );
    }
 
};
 
} //namespace [dxl]
 
#endif // HPP_DXL_THREADPOOL