juce_CriticalSection.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the juce_core module of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission to use, copy, modify, and/or distribute this software for any purpose with
   or without fee is hereby granted, provided that the above copyright notice and this
   permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
   DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
   IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
   ------------------------------------------------------------------------------
 
   NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
   All other JUCE modules are covered by a dual GPL/commercial license, so if you are
   using any other modules, be sure to check that you also comply with their license.
 
   For more details, visit www.juce.com
 
  ==============================================================================
*/
 
#ifndef JUCE_CRITICALSECTION_H_INCLUDED
#define JUCE_CRITICALSECTION_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  CriticalSection
{
public:
    //==============================================================================
    CriticalSection() noexcept;
 
    ~CriticalSection() noexcept;
 
    //==============================================================================
    void enter() const noexcept;
 
    bool tryEnter() const noexcept;
 
    void exit() const noexcept;
 
 
    //==============================================================================
    typedef GenericScopedLock <CriticalSection>       ScopedLockType;
 
    typedef GenericScopedUnlock <CriticalSection>     ScopedUnlockType;
 
    typedef GenericScopedTryLock <CriticalSection>    ScopedTryLockType;
 
 
private:
    //==============================================================================
   #if JUCE_WINDOWS
    // To avoid including windows.h in the public JUCE headers, we'll just allocate
    // a block of memory here that's big enough to be used internally as a windows
    // CRITICAL_SECTION structure.
    #if JUCE_64BIT
     uint8 lock[44];
    #else
     uint8 lock[24];
    #endif
   #else
    mutable pthread_mutex_t lock;
   #endif
 
    JUCE_DECLARE_NON_COPYABLE (CriticalSection)
};
 
 
//==============================================================================
class JUCE_API  DummyCriticalSection
{
public:
    inline DummyCriticalSection() noexcept      {}
    inline ~DummyCriticalSection() noexcept     {}
 
    inline void enter() const noexcept          {}
    inline bool tryEnter() const noexcept       { return true; }
    inline void exit() const noexcept           {}
 
    //==============================================================================
    struct ScopedLockType
    {
        ScopedLockType (const DummyCriticalSection&) noexcept {}
    };
 
    typedef ScopedLockType ScopedUnlockType;
 
private:
    JUCE_DECLARE_NON_COPYABLE (DummyCriticalSection)
};
 
//==============================================================================
typedef CriticalSection::ScopedLockType  ScopedLock;
 
//==============================================================================
typedef CriticalSection::ScopedUnlockType  ScopedUnlock;
 
//==============================================================================
typedef CriticalSection::ScopedTryLockType  ScopedTryLock;
 
 
#endif   // JUCE_CRITICALSECTION_H_INCLUDED