1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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.
*
*=========================================================================*/
/*=========================================================================
*
* Portions of this file are subject to the VTK Toolkit Version 3 copyright.
*
* Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
*
* For complete copyright, license and disclaimer of warranty information
* please refer to the NOTICE file at the top of the ITK source tree.
*
*=========================================================================*/
#ifndef itkFastMutexLock_h
#define itkFastMutexLock_h
#include "itkObject.h"
#include "itkSimpleFastMutexLock.h"
#include "itkObjectFactory.h"
namespace itk
{
/**
* \class FastMutexLock
* \brief Critical section locking class.
*
* FastMutexLock allows the locking of variables which are accessed
* through different threads. This header file also defines
* SimpleFastMutexLock which is not a subclass of Object.
* The API is identical to that of MutexLock, and the behavior is
* identical as well, except on Windows 9x/NT platforms. The only difference
* on these platforms is that MutexLock is more flexible, in that
* it works across processes as well as across threads, but also costs
* more, in that it evokes a 600-cycle x86 ring transition. The
* FastMutexLock provides a higher-performance equivalent (on
* Windows) but won't work across processes. Since it is unclear how,
* in itk, an object at the itk level can be shared across processes
* in the first place, one should use FastMutexLock unless one has
* a very good reason to use MutexLock. If higher-performance equivalents
* for non-Windows platforms (Irix, SunOS, etc) are discovered, they
* should replace the implementations in this class
*
* \ingroup OSSystemObjects
* \ingroup ITKDeprecated
*/
class ITKDeprecated_EXPORT FastMutexLock : public Object
{
public:
ITK_DISALLOW_COPY_AND_MOVE(FastMutexLock);
/** Standard class type aliases. */
using Self = FastMutexLock;
using Superclass = Object;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(FastMutexLock);
/** Lock the itkFastMutexLock. */
void
Lock();
/** Non-blocking Lock access.
\return bool - true if lock is captured, false if it was already held by someone else.
*/
bool
TryLock();
/** Unlock the FastMutexLock. */
void
Unlock();
protected:
FastMutexLock() = default;
~FastMutexLock() override = default;
SimpleFastMutexLock m_SimpleFastMutexLock{};
void
PrintSelf(std::ostream & os, Indent indent) const override;
};
inline void
FastMutexLock::Lock()
{
m_SimpleFastMutexLock.Lock();
}
inline bool
FastMutexLock::TryLock()
{
return m_SimpleFastMutexLock.TryLock();
}
inline void
FastMutexLock::Unlock()
{
m_SimpleFastMutexLock.Unlock();
}
} // namespace itk
#endif
|