mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 02:55:50 +00:00
86 lines
3.0 KiB
C++
86 lines
3.0 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of Beast: https://github.com/vinniefalco/Beast
|
|
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
|
|
|
Portions of this file are from JUCE.
|
|
Copyright (c) 2013 - Raw Material Software Ltd.
|
|
Please visit http://www.juce.com
|
|
|
|
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.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef BEAST_SCOPEDWRITELOCK_BEASTHEADER
|
|
#define BEAST_SCOPEDWRITELOCK_BEASTHEADER
|
|
|
|
#include "beast_ReadWriteLock.h"
|
|
|
|
|
|
//==============================================================================
|
|
/**
|
|
Automatically locks and unlocks a ReadWriteLock object.
|
|
|
|
Use one of these as a local variable to control access to a ReadWriteLock.
|
|
|
|
e.g. @code
|
|
|
|
ReadWriteLock myLock;
|
|
|
|
for (;;)
|
|
{
|
|
const ScopedWriteLock myScopedLock (myLock);
|
|
// myLock is now locked
|
|
|
|
...do some stuff...
|
|
|
|
// myLock gets unlocked here.
|
|
}
|
|
@endcode
|
|
|
|
@see ReadWriteLock, ScopedReadLock
|
|
*/
|
|
class BEAST_API ScopedWriteLock : Uncopyable
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a ScopedWriteLock.
|
|
|
|
As soon as it is created, this will call ReadWriteLock::enterWrite(), and
|
|
when the ScopedWriteLock object is deleted, the ReadWriteLock will
|
|
be unlocked.
|
|
|
|
Make sure this object is created and deleted by the same thread,
|
|
otherwise there are no guarantees what will happen! Best just to use it
|
|
as a local stack object, rather than creating one with the new() operator.
|
|
*/
|
|
inline explicit ScopedWriteLock (const ReadWriteLock& lock) noexcept : lock_ (lock) { lock.enterWrite(); }
|
|
|
|
/** Destructor.
|
|
|
|
The ReadWriteLock's exitWrite() method will be called when the destructor is called.
|
|
|
|
Make sure this object is created and deleted by the same thread,
|
|
otherwise there are no guarantees what will happen!
|
|
*/
|
|
inline ~ScopedWriteLock() noexcept { lock_.exitWrite(); }
|
|
|
|
|
|
private:
|
|
//==============================================================================
|
|
const ReadWriteLock& lock_;
|
|
};
|
|
|
|
|
|
#endif // BEAST_SCOPEDWRITELOCK_BEASTHEADER
|