poco/Foundation/include/Poco/ActiveThreadPool.h

99 lines
2.8 KiB
C
Raw Normal View History

//
// ActiveThreadPool.h
//
// Library: Foundation
// Package: Threading
// Module: ActiveThreadPool
//
// Definition of the ActiveThreadPool class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//
#ifndef Foundation_ActiveThreadPool_INCLUDED
#define Foundation_ActiveThreadPool_INCLUDED
#include "Poco/Foundation.h"
#include "Poco/Thread.h"
#include "Poco/Environment.h"
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
#include <memory>
namespace Poco {
class Runnable;
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
class ActiveThreadPoolPrivate;
class Foundation_API ActiveThreadPool
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
/// A thread pool manages and recycles individual Poco::Thread objects
/// to help reduce thread creation costs in programs that use threads.
///
/// The thread pool supports a task queue.
/// When there are no idle threads, tasks are placed in the task queue to wait for execution.
/// Use case for this pool is running many (more than os-max-thread-count) short live tasks
{
public:
ActiveThreadPool(int capacity = static_cast<int>(Environment::processorCount()) + 1,
int stackSize = POCO_THREAD_STACK_SIZE);
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
/// Creates a thread pool with a maximum thread count of capacity.
/// Threads are created with given stack size.
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
ActiveThreadPool(const std::string& name,
int capacity = static_cast<int>(Environment::processorCount()) + 1,
int stackSize = POCO_THREAD_STACK_SIZE);
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
/// Creates a thread pool with the given name and a maximum thread count of capacity.
/// Threads are created with given stack size.
~ActiveThreadPool();
/// Currently running threads will remain active
/// until they complete.
int capacity() const;
/// Returns the capacity of threads.
int getStackSize() const;
/// Returns the stack size used to create new threads.
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
int expiryTimeout() const;
/// Returns the thread expiry timeout value in milliseconds.
/// The default expiryTimeout is 30000 milliseconds (30 seconds).
void setExpiryTimeout(int expiryTimeout);
/// Set the thread expiry timeout value in milliseconds.
/// The default expiryTimeout is 30000 milliseconds (30 seconds).
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
void start(Runnable& target, int priority = 0);
/// Obtains a thread and starts the target.
void joinAll();
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
/// Waits for all threads to exit and removes all threads from the thread pool.
const std::string& name() const;
/// Returns the name of the thread pool,
/// or an empty string if no name has been
/// specified in the constructor.
static ActiveThreadPool& defaultPool();
/// Returns a reference to the default
/// thread pool.
private:
ActiveThreadPool(const ActiveThreadPool& pool);
ActiveThreadPool& operator = (const ActiveThreadPool& pool);
enh(Poco::ActiveThreadPool): make it easy to use correctly (#4624) * make Poco::ActiveThreadPool easy to use (#4544) * code format * Fix ThreadSanitizer thread leak error * enh(ActivePooledThread): Change pointers to references * enh(ActivePooledThread): remove unused method * enh(Poco::ActiveThreadPool): Use std::unique_ptr instead of raw pointer * enh(Poco::ActiveThreadPool): Use C++ static_cast instead of C casting * enh(Poco::ActiveThreadPool): Use standard containers instead of implementing own * enh(Poco::ActiveThreadPool): Change pointer to reference * enh(Poco::ActiveThreadPool): Use smart pointers instead of bare pointers * enh(Poco::ActiveThreadPool): Fix codeql warning: A stack address which arrived via a may be assigned to a non-local variable. * enh(Poco::ActiveThreadPool): More test case * enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions * enh(Poco::ActiveThreadPool): Fix compare function for make heap * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Add more test case * enh(Poco::ActiveThreadPool): Code style * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Test case * enh(Poco::ActiveThreadPool): Fix test case error * Revert "enh(Poco::ActiveThreadPool): std::optional::value unavailable on earlier macOS versions" This reverts commit cba4673b47761192d118eadf320b92f880071404. * enh(macOS): require min deployment macOS version 10.15 which has full support for C++17 * enh(Poco::ActiveThreadPool): Remove useless "{}" * enh(Poco::ActiveThreadPool): Rename member variable m_impl to _impl --------- Co-authored-by: Matej Kenda <matejken@gmail.com>
2024-08-30 11:54:44 +02:00
private:
std::unique_ptr<ActiveThreadPoolPrivate> _impl;
};
} // namespace Poco
#endif // Foundation_ActiveThreadPool_INCLUDED