blocxx
ThreadPool.hpp
Go to the documentation of this file.
1/*******************************************************************************
2* Copyright (C) 2005, Vintela, Inc. All rights reserved.
3* Copyright (C) 2006, Novell, Inc. All rights reserved.
4*
5* Redistribution and use in source and binary forms, with or without
6* modification, are permitted provided that the following conditions are met:
7*
8* * Redistributions of source code must retain the above copyright notice,
9* this list of conditions and the following disclaimer.
10* * Redistributions in binary form must reproduce the above copyright
11* notice, this list of conditions and the following disclaimer in the
12* documentation and/or other materials provided with the distribution.
13* * Neither the name of
14* Vintela, Inc.,
15* nor Novell, Inc.,
16* nor the names of its contributors or employees may be used to
17* endorse or promote products derived from this software without
18* specific prior written permission.
19*
20* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30* POSSIBILITY OF SUCH DAMAGE.
31*******************************************************************************/
32
33
38#ifndef BLOCXX_THREAD_POOL_HPP_INCLUDE_GUARD_
39#define BLOCXX_THREAD_POOL_HPP_INCLUDE_GUARD_
40#include "blocxx/BLOCXX_config.h"
41#include "blocxx/Types.hpp"
44#include "blocxx/Runnable.hpp"
45#include "blocxx/Exception.hpp"
46#include "blocxx/Logger.hpp"
47#include "blocxx/Timeout.hpp"
48
49namespace BLOCXX_NAMESPACE
50{
51
52class ThreadPoolImpl;
63class BLOCXX_COMMON_API ThreadPool : public IntrusiveCountableBase
64{
65public:
67 {
70 DYNAMIC_SIZE_NO_QUEUE
71 };
72 enum
73 {
74 UNLIMITED_QUEUE_SIZE = 0
75 };
105 ThreadPool(PoolType poolType, UInt32 numThreads, UInt32 maxQueueSize, const Logger& logger, const String& poolName="");
106 ThreadPool(PoolType poolType, UInt32 numThreads, UInt32 maxQueueSize, const String& poolName="");
112 bool addWork(const RunnableRef& work);
118 bool tryAddWork(const RunnableRef& work);
124 bool tryAddWork(const RunnableRef& work, const Timeout& timeout);
126 {
128 E_FINISH_WORK_IN_QUEUE
129 };
145 void shutdown(EShutdownQueueFlag finishWorkInQueue = E_FINISH_WORK_IN_QUEUE, const Timeout& timeout = Timeout::infinite);
146 void shutdown(EShutdownQueueFlag finishWorkInQueue, int timeoutSecs) BLOCXX_DEPRECATED; // in 4.0.0
147
170 void shutdown(EShutdownQueueFlag finishWorkInQueue, const Timeout& shutdownTimeout, const Timeout& definitiveCancelTimeout);
171
175 void waitForEmptyQueue();
180 ~ThreadPool();
181 ThreadPool(const ThreadPool& x);
182 ThreadPool& operator=(const ThreadPool& x);
183private:
184
185#ifdef BLOCXX_WIN32
186#pragma warning (push)
187#pragma warning (disable: 4251)
188#endif
189
191
192#ifdef BLOCXX_WIN32
193#pragma warning (pop)
194#endif
195
196};
198
199} // end namespace BLOCXX_NAMESPACE
200
201#endif
#define BLOCXX_DECLARE_APIEXCEPTION(NAME, LINKAGE_SPEC)
Declare a new exception class named <NAME>Exception that derives from Exception This macro is typical...
Logging interface.
Definition Logger.hpp:87
This String class is an abstract data type that represents as NULL terminated string of characters.
Definition String.hpp:67
The ThreadPool class is used to coordinate a group of threads.
IntrusiveReference< ThreadPoolImpl > m_impl
A timeout can be absolute, which means that it will happen at the specified DateTime.
Definition Timeout.hpp:56
Taken from RFC 1321.
BLOCXX_EXPORT_TEMPLATE(BLOCXX_COMMON_API, Array, Bool)