itkThreadPool.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkThreadPool_h
#define itkThreadPool_h

#include "itkConfigure.h"
#include "itkIntTypes.h"

#include <map>
#include <set>
#include <deque>

#include "itkThreadJob.h"
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkSimpleFastMutexLock.h"
#include "itkMutexLockHolder.h"

namespace itk
{

class ITKCommon_EXPORT ThreadPool : public Object
{
public:

  typedef ThreadPool               Self;
  typedef Object                   Superclass;
  typedef SmartPointer< Self >     Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  typedef ThreadJob::Semaphore Semaphore;

  itkTypeMacro(ThreadPool, Object);

  static Pointer New();

  static Pointer GetInstance();

  void AddWork(const ThreadJob& job);

  void AddThreads(ThreadIdType count);

  int GetNumberOfCurrentlyIdleThreads() const;

  void WaitForJob(Semaphore& jobSemaphore);

  static ThreadIdType GetGlobalDefaultNumberOfThreadsByPlatform();

  static ThreadIdType GetGlobalDefaultNumberOfThreads();

protected:

  static void PlatformCreate(Semaphore &semaphore);
  static void PlatformWait(Semaphore &semaphore);
  static void PlatformSignal(Semaphore &semaphore);
  static void PlatformDelete(Semaphore &semaphore);
  static bool PlatformClose(ThreadProcessIdType &threadId); //returns success status

  void AddThread();

  void DeleteThreads();

  ThreadPool();
  virtual ~ThreadPool() ITK_OVERRIDE;

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(ThreadPool);

  bool m_ExceptionOccurred;

  std::deque<ThreadJob> m_WorkQueue;

  Semaphore m_ThreadsSemaphore;

  std::vector<ThreadProcessIdType> m_Threads;

  static SimpleFastMutexLock m_Mutex;

  static Pointer m_ThreadPoolInstance;

  static ITK_THREAD_RETURN_TYPE ThreadExecute(void *param);
};

}
#endif