vtkSimpleCriticalSection.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkCriticalSection.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkSimpleCriticalSection_h
#define vtkSimpleCriticalSection_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDeprecation.h"      // For VTK_DEPRECATED_IN_9_1_0
#include "vtkSystemIncludes.h"
#include "vtkThreads.h" // for VTK_USE_PTHREADS and VTK_USE_WIN32_THREADS
 
#if defined(VTK_USE_PTHREADS)
#include <pthread.h> // Needed for pthreads implementation of mutex
typedef pthread_mutex_t vtkCritSecType;
#endif
 
#ifdef VTK_USE_WIN32_THREADS
#include "vtkWindows.h" // Needed for win32 implementation of mutex
typedef CRITICAL_SECTION vtkCritSecType;
#endif
 
#ifndef VTK_USE_PTHREADS
#ifndef VTK_USE_WIN32_THREADS
typedef int vtkCritSecType;
#endif
#endif
 
// Critical Section object that is not a vtkObject.
class VTK_DEPRECATED_IN_9_1_0(
  "Use std::mutex instead.") VTKCOMMONCORE_EXPORT vtkSimpleCriticalSection
{
public:
  // Default cstor
  vtkSimpleCriticalSection() { this->Init(); }
  // Construct object locked if isLocked is different from 0
  vtkSimpleCriticalSection(int isLocked)
  {
    this->Init();
    if (isLocked)
    {
      this->Lock();
    }
  }
  // Destructor
  virtual ~vtkSimpleCriticalSection();
 
  void Init();
 
  void Lock();
 
  void Unlock();
 
protected:
  vtkCritSecType CritSec;
 
private:
  vtkSimpleCriticalSection(const vtkSimpleCriticalSection& other) = delete;
  vtkSimpleCriticalSection& operator=(const vtkSimpleCriticalSection& rhs) = delete;
};
 
#endif
// VTK-HeaderTest-Exclude: vtkSimpleCriticalSection.h