Class RWLockReader

Read-preferring read write lock

Hierarchy

RWLockReader

Implements

Lockable

Index

Constructors

Properties

_readerCount _writerCount acquireWritersLockP readerCountBlocked readersLock writersLock writersRelease

Accessors

count readerCount writerCount

Methods

isLocked lock read waitForUnlock withF withG withReadF withReadG withWriteF withWriteG write

Constructors

constructor

new RWLockReader(): RWLockReader
Returns RWLockReader

Properties

`Protected` _readerCount

_readerCount: number = 0

`Protected` _writerCount

_writerCount: number = 0

`Protected` acquireWritersLockP

acquireWritersLockP: PromiseCancellable<readonly [ResourceRelease, undefined | Lock]>

`Protected` readerCountBlocked

readerCountBlocked: number = 0

`Protected` readersLock

readersLock: Lock = ...

`Protected` writersLock

writersLock: Lock = ...

`Protected` writersRelease

writersRelease: ResourceRelease

Accessors

count

get count(): number
Returns number
Implementation of Lockable.count
- Defined in src/RWLockReader.ts:29

readerCount

get readerCount(): number
Returns number
- Defined in src/RWLockReader.ts:33

writerCount

get writerCount(): number
Returns number
- Defined in src/RWLockReader.ts:37

Methods

isLocked

isLocked(type?): boolean
Check if locked If passed type, it will also check that the active lock is of that type
Parameters
- Optional type: "read" | "write"
Returns boolean
Implementation of Lockable.isLocked
- Defined in src/RWLockReader.ts:45

lock

lock(...params): ResourceAcquireCancellable<RWLockReader>
Parameters
- Rest ...params: [] | [type?: "read" | "write", ctx?: Partial<ContextTimedInput>] | [type?: "read" | "write"] | [ctx?: Partial<ContextTimedInput>]
Returns ResourceAcquireCancellable<RWLockReader>
Implementation of Lockable.lock
- Defined in src/RWLockReader.ts:59

read

read(ctx?): ResourceAcquireCancellable<RWLockReader>
Parameters
- Optional ctx: Partial<ContextTimedInput>
Returns ResourceAcquireCancellable<RWLockReader>
- Defined in src/RWLockReader.ts:86

waitForUnlock

waitForUnlock(ctx?): PromiseCancellable<void>
Parameters
- Optional ctx: Partial<ContextTimedInput>
Returns PromiseCancellable<void>
Implementation of Lockable.waitForUnlock
- Defined in src/RWLockReader.ts:183

withF

withF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [((lock) => Promise<T>)] | [undefined | "read" | "write", undefined | Partial<ContextTimedInput>, ((lock) => Promise<T>)] | [undefined | "read" | "write", ((lock) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((lock) => Promise<T>)]
Returns Promise<T>
Implementation of Lockable.withF
- Defined in src/RWLockReader.ts:204

withG

withG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [((lock) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | "read" | "write", undefined | Partial<ContextTimedInput>, ((lock) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | "read" | "write", ((lock) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | Partial<ContextTimedInput>, ((lock) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
Implementation of Lockable.withG
- Defined in src/RWLockReader.ts:254

withReadF

withReadF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [((lock) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((lock) => Promise<T>)]
Returns Promise<T>
- Defined in src/RWLockReader.ts:234

withReadG

withReadG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [((lock) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | Partial<ContextTimedInput>, ((lock) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
- Defined in src/RWLockReader.ts:284

withWriteF

withWriteF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [((lock) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((lock) => Promise<T>)]
Returns Promise<T>
- Defined in src/RWLockReader.ts:244

withWriteG

withWriteG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [((lock) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | Partial<ContextTimedInput>, ((lock) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
- Defined in src/RWLockReader.ts:296

write

write(ctx?): ResourceAcquireCancellable<RWLockReader>
Parameters
- Optional ctx: Partial<ContextTimedInput>
Returns ResourceAcquireCancellable<RWLockReader>
- Defined in src/RWLockReader.ts:146

Generated using TypeDoc