ThreadPool.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/
 
 
#ifndef BLOCXX_THREAD_POOL_HPP_INCLUDE_GUARD_
#define BLOCXX_THREAD_POOL_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/Types.hpp"
#include "blocxx/IntrusiveReference.hpp"
#include "blocxx/IntrusiveCountableBase.hpp"
#include "blocxx/Runnable.hpp"
#include "blocxx/Exception.hpp"
#include "blocxx/Logger.hpp"
#include "blocxx/Timeout.hpp"
 
namespace BLOCXX_NAMESPACE
{
 
class ThreadPoolImpl;
BLOCXX_DECLARE_APIEXCEPTION(ThreadPool, BLOCXX_COMMON_API);
class BLOCXX_COMMON_API ThreadPool : public IntrusiveCountableBase
{
public:
   enum PoolType
   {
      FIXED_SIZE,
      DYNAMIC_SIZE,
      DYNAMIC_SIZE_NO_QUEUE
   };
   enum
   {
      UNLIMITED_QUEUE_SIZE = 0
   };
   ThreadPool(PoolType poolType, UInt32 numThreads, UInt32 maxQueueSize, const Logger& logger, const String& poolName="");
   ThreadPool(PoolType poolType, UInt32 numThreads, UInt32 maxQueueSize, const String& poolName="");
   bool addWork(const RunnableRef& work);
   bool tryAddWork(const RunnableRef& work);
   bool tryAddWork(const RunnableRef& work, const Timeout& timeout);
   enum EShutdownQueueFlag
   {
      E_DISCARD_WORK_IN_QUEUE,
      E_FINISH_WORK_IN_QUEUE
   };
   void shutdown(EShutdownQueueFlag finishWorkInQueue = E_FINISH_WORK_IN_QUEUE, const Timeout& timeout = Timeout::infinite);
   void shutdown(EShutdownQueueFlag finishWorkInQueue, int timeoutSecs) BLOCXX_DEPRECATED; // in 4.0.0
   
   void shutdown(EShutdownQueueFlag finishWorkInQueue, const Timeout& shutdownTimeout, const Timeout& definitiveCancelTimeout);
   
   void waitForEmptyQueue();
   ~ThreadPool();
   ThreadPool(const ThreadPool& x);
   ThreadPool& operator=(const ThreadPool& x);
private:
 
#ifdef BLOCXX_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif
 
   IntrusiveReference<ThreadPoolImpl> m_impl;
 
#ifdef BLOCXX_WIN32
#pragma warning (pop)
#endif
 
};
BLOCXX_EXPORT_TEMPLATE(BLOCXX_COMMON_API, IntrusiveReference, ThreadPool);
 
} // end namespace BLOCXX_NAMESPACE
 
#endif