JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::SpinLock Class Reference

A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations. More...

#include <juce_SpinLock.h>

Collaboration diagram for juce::SpinLock:

Public Types

using ScopedLockType = GenericScopedLock< SpinLock >
 Provides the type of scoped lock to use for locking a SpinLock. More...
 
using ScopedTryLockType = GenericScopedTryLock< SpinLock >
 Provides the type of scoped try-lock to use for locking a SpinLock. More...
 
using ScopedUnlockType = GenericScopedUnlock< SpinLock >
 Provides the type of scoped unlocker to use with a SpinLock. More...
 

Public Member Functions

 SpinLock ()=default
 
 ~SpinLock ()=default
 
void enter () const noexcept
 Acquires the lock. More...
 
void exit () const noexcept
 Releases the lock. More...
 
bool tryEnter () const noexcept
 Attempts to acquire the lock, returning true if this was successful. More...
 

Private Attributes

Atomic< intlock
 

Detailed Description

A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations.

Note that unlike a CriticalSection, this type of lock is not re-entrant, and may be less efficient when used in a highly contended situation, but it's very small and requires almost no initialisation. It's most appropriate for simple situations where you're only going to hold the lock for a very brief time.

See also
CriticalSection

@tags{Core}

Member Typedef Documentation

◆ ScopedLockType

Provides the type of scoped lock to use for locking a SpinLock.

◆ ScopedTryLockType

Provides the type of scoped try-lock to use for locking a SpinLock.

◆ ScopedUnlockType

Provides the type of scoped unlocker to use with a SpinLock.

Constructor & Destructor Documentation

◆ SpinLock()

juce::SpinLock::SpinLock ( )
inlinedefault

◆ ~SpinLock()

juce::SpinLock::~SpinLock ( )
inlinedefault

Member Function Documentation

◆ enter()

void juce::SpinLock::enter ( ) const
noexcept

Acquires the lock.

This will block until the lock has been successfully acquired by this thread. Note that a SpinLock is NOT re-entrant, and is not smart enough to know whether the caller thread already has the lock - so if a thread tries to acquire a lock that it already holds, this method will never return!

It's strongly recommended that you never call this method directly - instead use the ScopedLockType class to manage the locking using an RAII pattern instead.

◆ exit()

void juce::SpinLock::exit ( ) const
inlinenoexcept

Releases the lock.

References jassert.

◆ tryEnter()

bool juce::SpinLock::tryEnter ( ) const
inlinenoexcept

Attempts to acquire the lock, returning true if this was successful.

Member Data Documentation

◆ lock

Atomic<int> juce::SpinLock::lock
mutableprivate

The documentation for this class was generated from the following file: