Class Mutex

a mutual exclusion lock.

Hierarchy

Mutex

Implements

Locker

Index

Constructors

Properties

Methods

_lock lock tryLock unlock

Constructors

constructor

new Mutex(): Mutex
Returns Mutex

Properties

`Private` c_

c_: undefined | Completer<void>

Methods

`Private` _lock

_lock(): Promise<Locker>
Returns Promise<Locker>
- Defined in src/sync/mutex.ts:43

lock

lock(): undefined | Promise<Locker>
locks

Remarks
if the lock no used, lock and return undefined. If the lock is already in use, return a Promise wait for mutex is available.

Returns undefined | Promise<Locker>
Implementation of Locker.lock
- Defined in src/sync/mutex.ts:37

tryLock

tryLock(): boolean
try locks.

Returns
if successful locked return true, else return false

Returns boolean
Implementation of Locker.tryLock
- Defined in src/sync/mutex.ts:23

unlock

unlock(): void
unlocks

Remarks
if is not locked on entry to Unlock, throw MutexException

Throws
MutexException

Returns void
Implementation of Locker.unlock
- Defined in src/sync/mutex.ts:60

Generated using TypeDoc