ThreadPool.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2004 Vintela, Inc. All rights reserved.
00003 * Copyright (C) 2005 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 *
00011 *  - Redistributions in binary form must reproduce the above copyright notice,
00012 *    this list of conditions and the following disclaimer in the documentation
00013 *    and/or other materials provided with the distribution.
00014 *
00015 *  - Neither the name of Vintela, Inc., Novell, Inc., nor the names of its
00016 *    contributors may be used to endorse or promote products derived from this
00017 *    software without specific prior written permission.
00018 *
00019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022 * ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc., Novell, Inc., OR THE 
00023 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00024 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
00025 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
00026 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
00027 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
00028 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
00029 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00030 *******************************************************************************/
00031 
00032 
00037 #ifndef BLOCXX_THREAD_POOL_HPP_INCLUDE_GUARD_
00038 #define BLOCXX_THREAD_POOL_HPP_INCLUDE_GUARD_
00039 #include "blocxx/BLOCXX_config.h"
00040 #include "blocxx/Types.hpp"
00041 #include "blocxx/IntrusiveReference.hpp"
00042 #include "blocxx/IntrusiveCountableBase.hpp"
00043 #include "blocxx/Runnable.hpp"
00044 #include "blocxx/Exception.hpp"
00045 #include "blocxx/Logger.hpp"
00046 
00047 namespace BLOCXX_NAMESPACE
00048 {
00049 
00050 class ThreadPoolImpl;
00051 BLOCXX_DECLARE_APIEXCEPTION(ThreadPool, BLOCXX_COMMON_API);
00061 class BLOCXX_COMMON_API ThreadPool : public IntrusiveCountableBase
00062 {
00063 public:
00064    enum PoolType
00065    {
00066       FIXED_SIZE,
00067       DYNAMIC_SIZE,
00068       DYNAMIC_SIZE_NO_QUEUE
00069    };
00070    enum
00071    {
00072       UNLIMITED_QUEUE_SIZE = 0
00073    };
00103    ThreadPool(PoolType poolType, UInt32 numThreads, UInt32 maxQueueSize, const LoggerRef& logger=LoggerRef(), const String& poolName="");
00109    bool addWork(const RunnableRef& work);
00115    bool tryAddWork(const RunnableRef& work);
00116    enum EShutdownQueueFlag
00117    {
00118       E_DISCARD_WORK_IN_QUEUE,
00119       E_FINISH_WORK_IN_QUEUE
00120    };
00136    void shutdown(EShutdownQueueFlag finishWorkInQueue = E_FINISH_WORK_IN_QUEUE, int timeoutSecs=-1);
00140    void waitForEmptyQueue();
00145    ~ThreadPool();
00146    ThreadPool(const ThreadPool& x);
00147    ThreadPool& operator=(const ThreadPool& x);
00148 private:
00149 
00150 #ifdef BLOCXX_WIN32
00151 #pragma warning (push)
00152 #pragma warning (disable: 4251)
00153 #endif
00154 
00155    IntrusiveReference<ThreadPoolImpl> m_impl;
00156 
00157 #ifdef BLOCXX_WIN32
00158 #pragma warning (pop)
00159 #endif
00160 
00161 };
00162 BLOCXX_EXPORT_TEMPLATE(BLOCXX_COMMON_API, IntrusiveReference, ThreadPool);
00163 
00164 } // end namespace BLOCXX_NAMESPACE
00165 
00166 #endif

Generated on Fri Jun 16 15:39:09 2006 for blocxx by  doxygen 1.4.6