OpenShot Library | libopenshot-audio 0.2.0
juce::InterProcessLock Class Reference

Acts as a critical section which processes can use to block each other. More...

#include <juce_InterProcessLock.h>

Classes

class  ScopedLockType
 Automatically locks and unlocks an InterProcessLock object. More...
 

Public Member Functions

 InterProcessLock (const String &name)
 Creates a lock object.
 
 ~InterProcessLock ()
 Destructor.
 
bool enter (int timeOutMillisecs=-1)
 Attempts to lock the critical section.
 
void exit ()
 Releases the lock if it's currently held by this process.
 

Detailed Description

Acts as a critical section which processes can use to block each other.

See also
CriticalSection

Definition at line 38 of file juce_InterProcessLock.h.

Constructor & Destructor Documentation

◆ InterProcessLock()

juce::InterProcessLock::InterProcessLock ( const String name)
explicit

Creates a lock object.

Parameters
namea 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.

Member Function Documentation

◆ enter()

bool juce::InterProcessLock::enter ( int  timeOutMillisecs = -1)

Attempts to lock the critical section.

Parameters
timeOutMillisecshow 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.

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