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

#include "juce_InterProcessLock.h"

Classes
class	Pimpl

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

@tags{Core}

Definition at line 34 of file juce_InterProcessLock.h.

Constructor & Destructor Documentation

◆ 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

Definition at line 817 of file juce_SharedCode_posix.h.

◆ ~InterProcessLock()

juce::InterProcessLock::~InterProcessLock ( )

Destructor.

This will also release the lock if it's currently held by this process.

Definition at line 821 of file juce_SharedCode_posix.h.

Member Function Documentation

◆ 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.

Definition at line 825 of file juce_SharedCode_posix.h.

◆ exit()

void juce::InterProcessLock::exit ( )

Releases the lock if it's currently held by this process.

Definition at line 844 of file juce_SharedCode_posix.h.

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

juce_core/threads/juce_InterProcessLock.h
juce_core/native/juce_SharedCode_posix.h

Classes