kcenon::pacs::integration::thread_pool_interface Class Reference

Abstract interface for thread pool operations. More...

#include <thread_pool_interface.h>

Inheritance diagram for kcenon::pacs::integration::thread_pool_interface:

Collaboration diagram for kcenon::pacs::integration::thread_pool_interface:

Public Member Functions
virtual	~thread_pool_interface ()=default
	Virtual destructor for proper polymorphic destruction.
virtual auto	start () -> bool=0
	Start the thread pool.
virtual auto	is_running () const noexcept -> bool=0
	Check if the thread pool is running.
virtual void	shutdown (bool wait_for_completion=true)=0
	Shutdown the thread pool.
virtual auto	submit (std::function< void()> task) -> std::future< void >=0
	Submit a task for execution.
virtual auto	submit_with_priority (job_priority priority, std::function< void()> task) -> std::future< void >=0
	Submit a task with a specific priority level.
virtual void	submit_fire_and_forget (std::function< void()> task)=0
	Submit a task without waiting for completion.
virtual auto	get_thread_count () const -> std::size_t=0
	Get the current number of worker threads.
virtual auto	get_pending_task_count () const -> std::size_t=0
	Get the number of pending tasks in the queue.
virtual auto	get_idle_worker_count () const -> std::size_t=0
	Get the number of idle workers.

Protected Member Functions
	thread_pool_interface ()=default
	Protected default constructor for derived classes.
	thread_pool_interface (const thread_pool_interface &)=delete
	Non-copyable.
thread_pool_interface &	operator= (const thread_pool_interface &)=delete
	thread_pool_interface (thread_pool_interface &&)=default
	Movable.
thread_pool_interface &	operator= (thread_pool_interface &&)=default

Detailed Description

Abstract interface for thread pool operations.

Provides a unified API for submitting tasks to a thread pool and managing its lifecycle. This interface enables dependency injection, allowing components to receive a thread pool instance rather than depending on global state.

Benefits:

• Testability: Mock implementations can be injected for unit testing
• Flexibility: Different thread pool configurations per component
• Clean Architecture: Follows Dependency Inversion Principle (SOLID)

Thread Safety:

• All methods must be thread-safe in concrete implementations
• Concurrent task submission is allowed

Example:

// Using dependency injection
class my_service {
public:
    explicit my_service(std::shared_ptr<thread_pool_interface> pool)
        : pool_(std::move(pool)) {}
 
    void process_async() {
        pool_->submit([this] { do_work(); });
    }
 
private:
    std::shared_ptr<thread_pool_interface> pool_;
};
 
// In production
auto pool = std::make_shared<thread_pool_adapter>(config);
auto service = my_service(pool);
 
// In tests
auto mock_pool = std::make_shared<mock_thread_pool>();
auto service = my_service(mock_pool);

Definition at line 112 of file thread_pool_interface.h.

Constructor & Destructor Documentation

~thread_pool_interface()

virtual kcenon::pacs::integration::thread_pool_interface::~thread_pool_interface ( )

virtualdefault

Virtual destructor for proper polymorphic destruction.

thread_pool_interface() [1/3]

kcenon::pacs::integration::thread_pool_interface::thread_pool_interface ( )

protecteddefault

Protected default constructor for derived classes.

thread_pool_interface() [2/3]

kcenon::pacs::integration::thread_pool_interface::thread_pool_interface ( const thread_pool_interface & )

protecteddelete

Non-copyable.

thread_pool_interface() [3/3]

kcenon::pacs::integration::thread_pool_interface::thread_pool_interface ( thread_pool_interface && )

protecteddefault

Movable.

Member Function Documentation

get_idle_worker_count()

virtual auto kcenon::pacs::integration::thread_pool_interface::get_idle_worker_count ( ) const -> std::size_t

nodiscardpure virtual

Get the number of idle workers.

Returns

Number of workers not currently processing tasks

Implemented in kcenon::pacs::integration::thread_pool_adapter.

get_pending_task_count()

virtual auto kcenon::pacs::integration::thread_pool_interface::get_pending_task_count ( ) const -> std::size_t

nodiscardpure virtual

Get the number of pending tasks in the queue.

Returns

Number of tasks waiting to be processed

Implemented in kcenon::pacs::integration::thread_pool_adapter.

get_thread_count()

virtual auto kcenon::pacs::integration::thread_pool_interface::get_thread_count ( ) const -> std::size_t

nodiscardpure virtual

Get the current number of worker threads.

Returns

Number of active worker threads

Implemented in kcenon::pacs::integration::thread_pool_adapter.

is_running()

virtual auto kcenon::pacs::integration::thread_pool_interface::is_running ( ) const -> bool

nodiscardpure virtualnoexcept

Check if the thread pool is running.

Returns

true if the pool is active and accepting tasks

Implemented in kcenon::pacs::integration::thread_pool_adapter.

operator=() [1/2]

thread_pool_interface & kcenon::pacs::integration::thread_pool_interface::operator= ( const thread_pool_interface & )

protecteddelete

operator=() [2/2]

thread_pool_interface & kcenon::pacs::integration::thread_pool_interface::operator= ( thread_pool_interface && )

protecteddefault

shutdown()

virtual void kcenon::pacs::integration::thread_pool_interface::shutdown ( bool wait_for_completion = true )

pure virtual

Shutdown the thread pool.

Stops accepting new tasks and optionally waits for pending tasks.

Parameters

wait_for_completion

If true, waits for all pending tasks to complete

Implemented in kcenon::pacs::integration::thread_pool_adapter.

start()

virtual auto kcenon::pacs::integration::thread_pool_interface::start ( ) -> bool

nodiscardpure virtual

Start the thread pool.

Initializes worker threads and begins accepting tasks. Safe to call multiple times; subsequent calls are no-ops if running.

Returns

true if started successfully or already running, false otherwise

Implemented in kcenon::pacs::integration::thread_pool_adapter.

submit()

virtual auto kcenon::pacs::integration::thread_pool_interface::submit ( std::function< void()> task ) -> std::future< void >

nodiscardpure virtual

Submit a task for execution.

Submits a void-returning task to the thread pool for asynchronous execution with normal priority.

Parameters

task	The task to execute (must be callable with no arguments)

Returns

Future that completes when the task finishes

Exceptions

std::runtime_error

if pool is not running

Implemented in kcenon::pacs::integration::thread_pool_adapter.

submit_fire_and_forget()

virtual void kcenon::pacs::integration::thread_pool_interface::submit_fire_and_forget ( std::function< void()> task )

pure virtual

Submit a task without waiting for completion.

Fire-and-forget submission for tasks where the result is not needed. Errors are logged but not propagated.

Parameters

task	The task to execute

Implemented in kcenon::pacs::integration::thread_pool_adapter.

submit_with_priority()

virtual auto kcenon::pacs::integration::thread_pool_interface::submit_with_priority ( job_priority priority, std::function< void()> task ) -> std::future< void >

nodiscardpure virtual

Submit a task with a specific priority level.

Jobs with higher priority (lower enum value) are processed first.

Parameters

priority	The priority level for this task
task	The task to execute

Returns

Future that completes when the task finishes

Exceptions

std::runtime_error

if pool is not running

Implemented in kcenon::pacs::integration::thread_pool_adapter.

---

The documentation for this class was generated from the following file:

• include/kcenon/pacs/integration/thread_pool_interface.h