Acts as a critical section which processes can use to block each other.
More...
#include <juce_InterProcessLock.h>
Acts as a critical section which processes can use to block each other.
- See also
- CriticalSection
@tags{Core}
◆ InterProcessLock()
juce::InterProcessLock::InterProcessLock |
( |
const String & |
name | ) |
|
|
explicit |
Creates a lock object.
- Parameters
-
name | a name that processes will use to identify this lock object |
◆ ~InterProcessLock()
juce::InterProcessLock::~InterProcessLock |
( |
| ) |
|
Destructor.
This will also release the lock if it's currently held by this process.
◆ enter()
bool juce::InterProcessLock::enter |
( |
int |
timeOutMillisecs = -1 | ) |
|
Attempts to lock the critical section.
- Parameters
-
timeOutMillisecs | how many milliseconds to wait if the lock is already held by another process - a value of 0 will return immediately, negative values will wait forever |
- Returns
- true if the lock could be gained within the timeout period, or false if the timeout expired.
References lock, name, and pimpl.
Referenced by juce::InterProcessLock::ScopedLockType::ScopedLockType().
◆ exit()
void juce::InterProcessLock::exit |
( |
| ) |
|
Releases the lock if it's currently held by this process.
References jassert, lock, and pimpl.
◆ lock
◆ name
String juce::InterProcessLock::name |
|
private |
◆ pimpl
std::unique_ptr<Pimpl> juce::InterProcessLock::pimpl |
|
private |
The documentation for this class was generated from the following files: