blocxx

ThreadPool.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2005, Vintela, Inc. All rights reserved.
00003 * Copyright (C) 2006, Novell, Inc. All rights reserved.
00004 * 
00005 * Redistribution and use in source and binary forms, with or without
00006 * modification, are permitted provided that the following conditions are met:
00007 * 
00008 *     * Redistributions of source code must retain the above copyright notice,
00009 *       this list of conditions and the following disclaimer.
00010 *     * Redistributions in binary form must reproduce the above copyright
00011 *       notice, this list of conditions and the following disclaimer in the
00012 *       documentation and/or other materials provided with the distribution.
00013 *     * Neither the name of 
00014 *       Vintela, Inc., 
00015 *       nor Novell, Inc., 
00016 *       nor the names of its contributors or employees may be used to 
00017 *       endorse or promote products derived from this software without 
00018 *       specific prior written permission.
00019 * 
00020 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00021 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00022 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00023 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00024 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00025 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00026 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00029 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030 * POSSIBILITY OF SUCH DAMAGE.
00031 *******************************************************************************/
00032 
00033 
00038 #ifndef BLOCXX_THREAD_POOL_HPP_INCLUDE_GUARD_
00039 #define BLOCXX_THREAD_POOL_HPP_INCLUDE_GUARD_
00040 #include "blocxx/BLOCXX_config.h"
00041 #include "blocxx/Types.hpp"
00042 #include "blocxx/IntrusiveReference.hpp"
00043 #include "blocxx/IntrusiveCountableBase.hpp"
00044 #include "blocxx/Runnable.hpp"
00045 #include "blocxx/Exception.hpp"
00046 #include "blocxx/Logger.hpp"
00047 #include "blocxx/Timeout.hpp"
00048 
00049 namespace BLOCXX_NAMESPACE
00050 {
00051 
00052 class ThreadPoolImpl;
00053 BLOCXX_DECLARE_APIEXCEPTION(ThreadPool, BLOCXX_COMMON_API);
00063 class BLOCXX_COMMON_API ThreadPool : public IntrusiveCountableBase
00064 {
00065 public:
00066    enum PoolType
00067    {
00068       FIXED_SIZE,
00069       DYNAMIC_SIZE,
00070       DYNAMIC_SIZE_NO_QUEUE
00071    };
00072    enum
00073    {
00074       UNLIMITED_QUEUE_SIZE = 0
00075    };
00105    ThreadPool(PoolType poolType, UInt32 numThreads, UInt32 maxQueueSize, const Logger& logger, const String& poolName="");
00106    ThreadPool(PoolType poolType, UInt32 numThreads, UInt32 maxQueueSize, const String& poolName="");
00112    bool addWork(const RunnableRef& work);
00118    bool tryAddWork(const RunnableRef& work);
00124    bool tryAddWork(const RunnableRef& work, const Timeout& timeout);
00125    enum EShutdownQueueFlag
00126    {
00127       E_DISCARD_WORK_IN_QUEUE,
00128       E_FINISH_WORK_IN_QUEUE
00129    };
00145    void shutdown(EShutdownQueueFlag finishWorkInQueue = E_FINISH_WORK_IN_QUEUE, const Timeout& timeout = Timeout::infinite);
00146    void shutdown(EShutdownQueueFlag finishWorkInQueue, int timeoutSecs) BLOCXX_DEPRECATED; // in 4.0.0
00147    
00170    void shutdown(EShutdownQueueFlag finishWorkInQueue, const Timeout& shutdownTimeout, const Timeout& definitiveCancelTimeout);
00171    
00175    void waitForEmptyQueue();
00180    ~ThreadPool();
00181    ThreadPool(const ThreadPool& x);
00182    ThreadPool& operator=(const ThreadPool& x);
00183 private:
00184 
00185 #ifdef BLOCXX_WIN32
00186 #pragma warning (push)
00187 #pragma warning (disable: 4251)
00188 #endif
00189 
00190    IntrusiveReference<ThreadPoolImpl> m_impl;
00191 
00192 #ifdef BLOCXX_WIN32
00193 #pragma warning (pop)
00194 #endif
00195 
00196 };
00197 BLOCXX_EXPORT_TEMPLATE(BLOCXX_COMMON_API, IntrusiveReference, ThreadPool);
00198 
00199 } // end namespace BLOCXX_NAMESPACE
00200 
00201 #endif