A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations. More...
|typedef GenericScopedLock< SpinLock >||ScopedLockType|
|Provides the type of scoped lock to use for locking a SpinLock. More...|
|typedef GenericScopedUnlock< SpinLock >||ScopedUnlockType|
|Provides the type of scoped unlocker to use with a SpinLock. More...|
|SpinLock () noexcept|
|~SpinLock () noexcept|
|void||enter () const noexcept|
|Acquires the lock. More...|
|bool||tryEnter () const noexcept|
|Attempts to acquire the lock, returning true if this was successful. More...|
|void||exit () const noexcept|
|Releases the lock. More...|
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 it 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
Member Typedef Documentation
Provides the type of scoped lock to use for locking a SpinLock.
Provides the type of scoped unlocker to use with a SpinLock.
Constructor & Destructor Documentation
Member Function Documentation
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.
Attempts to acquire the lock, returning true if this was successful.
Releases the lock.
The documentation for this class was generated from the following file:
Generated on Fri Jan 12 2018 09:51:22 for JUCE by 1.8.13