add doxygen via opencode
This commit is contained in:
@@ -1,3 +1,12 @@
|
||||
//! \file pithreadpoolexecutor.h
|
||||
//! \ingroup Thread
|
||||
//! \brief
|
||||
//! \~english Thread pool executor
|
||||
//! \~russian Исполнитель пула потоков
|
||||
//!
|
||||
//! \details
|
||||
//! \~english Executes tasks in a pool of worker threads.
|
||||
//! \~russian Выполняет задачи в пуле рабочих потоков.
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -26,10 +35,16 @@
|
||||
#include <atomic>
|
||||
|
||||
|
||||
//! \~english Thread pool executor for running tasks
|
||||
//! \~russian Исполнитель пула потоков для выполнения задач
|
||||
class PIP_EXPORT PIThreadPoolExecutor {
|
||||
public:
|
||||
//! \~english Constructs executor with core pool size
|
||||
//! \~russian Создает исполнитель с размером ядра пула
|
||||
explicit PIThreadPoolExecutor(int corePoolSize);
|
||||
|
||||
//! \~english Destroys executor
|
||||
//! \~russian Уничтожает исполнитель
|
||||
virtual ~PIThreadPoolExecutor();
|
||||
|
||||
//! \brief Executes the given task sometime in the future. The task execute in an existing pooled thread. If the task
|
||||
@@ -37,17 +52,27 @@ public:
|
||||
//! reached.
|
||||
//!
|
||||
//! \param runnable not empty function for thread pool execution
|
||||
//! \~english Execute task in thread pool
|
||||
//! \~russian Выполняет задачу в пуле потоков
|
||||
void execute(const std::function<void()> & runnable);
|
||||
|
||||
//! \~english Stop all threads immediately
|
||||
//! \~russian Немедленно останавливает все потоки
|
||||
void shutdownNow();
|
||||
|
||||
//! \brief Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be
|
||||
//! accepted. Invocation has no additional effect if already shut down. This method does not wait for previously
|
||||
//! submitted tasks to complete execution. Use awaitTermination to do that.
|
||||
//! \~english Initiates orderly shutdown
|
||||
//! \~russian Инициирует упорядоченное завершение
|
||||
void shutdown();
|
||||
|
||||
//! \~english Returns if executor is shutdown
|
||||
//! \~russian Возвращает остановлен ли исполнитель
|
||||
bool isShutdown() const;
|
||||
|
||||
//! \~english Wait for termination
|
||||
//! \~russian Ожидает завершения
|
||||
bool awaitTermination(PISystemTime timeout);
|
||||
|
||||
private:
|
||||
|
||||
Reference in New Issue
Block a user