Class Monitor<RWLock>

Type Parameters

RWLock extends RWLockReader | RWLockWriter

Hierarchy

Monitor

Implements

Lockable

Index

Constructors

constructor

new Monitor<RWLock>(lockBox, lockConstructor, locksPending?): Monitor<RWLock>
Type Parameters
- RWLock extends RWLockWriter | RWLockReader
Parameters
- lockBox: LockBox<RWLock>
- lockConstructor: (new () => RWLock)
  - - new (): RWLock
    - Returns RWLock
- Optional locksPending: Map<string, {
  count: number;
  }>
Returns Monitor<RWLock>
- Defined in src/Monitor.ts:48

Properties

`Protected` _locks

_locks: Map<string, {
    status: "acquiring";
    type: "read" | "write";
} | {
    lock: RWLock;
    release: ResourceRelease;
    status: "acquired";
    type: "read" | "write";
}> = ...

Monitor specific lock map.

`Protected` lockBox

lockBox: LockBox<RWLock>

Global lock box. Must be shared between all monitors.

`Protected` lockConstructor

lockConstructor: (new () => RWLock)

Type declaration

- new (): RWLock
- Lock constructor to be used.
  
  Returns RWLock

`Protected` `Optional` locksPending

locksPending?: Map<string, {
count: number;
}>

Global pending locks map. Only used for deadlock detection.

Type declaration

count: number

Accessors

count

get count(): number
The monitor count is isolated to this monitor. Use the shared lock box if you want to know the global count.

Returns number
Implementation of Lockable.count
- Defined in src/Monitor.ts:75

locks

get locks(): ReadonlyMap<string, {
    status: "acquiring";
    type: "read" | "write";
} | {
    lock: RWLock;
    release: ResourceRelease;
    status: "acquired";
    type: "read" | "write";
}>
Returns ReadonlyMap<string, {
    status: "acquiring";
    type: "read" | "write";
} | {
    lock: RWLock;
    release: ResourceRelease;
    status: "acquired";
    type: "read" | "write";
}>
- Defined in src/Monitor.ts:58

Methods

`Protected` checkForDeadlock

checkForDeadlock(key, lockType): boolean
Parameters
- key: string
- lockType: "read" | "write"
Returns boolean
- Defined in src/Monitor.ts:401

isLocked

isLocked(key?, type?): boolean
This checks if this monitor has locked the lock. Use the shared lock box if you want to know if it is globally locked.
Parameters
- Optional key: string
- Optional type: "read" | "write"
Returns boolean
Implementation of Lockable.isLocked
- Defined in src/Monitor.ts:83

lock

lock(...params): ResourceAcquireCancellable<Monitor<RWLock>>
Lock a sequence of lock requests. This defaults to using write locks the type is not specified. Keys are locked in string sorted order. Locking the same key is idempotent therefore lock re-entrancy is enabled. Keys are automatically unlocked in reverse sorted order in case of rejection. There is no support for lock upgrading or downgrading. Re-entrancy should work concurrently.
Parameters
- Rest ...params: (string | RWLockRequest)[] | [...requests: (string | RWLockRequest)[], ctx: Partial<ContextTimedInput>] | [ctx?: Partial<ContextTimedInput>]
Returns ResourceAcquireCancellable<Monitor<RWLock>>
Implementation of Lockable.lock
- Defined in src/Monitor.ts:118

`Protected` setPendingLock

setPendingLock(key, lockType): [string, {
count: number;
}]
Parameters
- key: string
- lockType: "read" | "write"
Returns [string, {
count: number;
}]
- Defined in src/Monitor.ts:368

unlock

unlock(...keys): Promise<void>
Unlock a sequence of lock keys. Unlocking will be done in the order of the keys. Unlocking can only be done for the keys locked by this monitor. Unlocking the same keys is idempotent.
Parameters
- Rest ...keys: string[]
Returns Promise<void>
- Defined in src/Monitor.ts:258

unlockAll

unlockAll(): Promise<void>
Returns Promise<void>
- Defined in src/Monitor.ts:270

`Protected` unsetPendingLock

unsetPendingLock(lockPendingKey, lockPending): void
Parameters
- lockPendingKey: string
- lockPending: {
  count: number;
  }
  - count: number
Returns void
- Defined in src/Monitor.ts:386

waitForUnlock

waitForUnlock(...params): PromiseCancellable<void>
This waits for a lock in this specific monitor. Use the shared lock box if you want globally wait for unlock.
Parameters
- Rest ...params: [] | [key?: string, ctx?: Partial<ContextTimedInput>] | [key?: string] | [ctx?: Partial<ContextTimedInput>]
Returns PromiseCancellable<void>
Implementation of Lockable.waitForUnlock
- Defined in src/Monitor.ts:279

withF

withF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [...(string | RWLockRequest)[], ((monitor) => Promise<T>)] | [...(string | RWLockRequest)[], Partial<ContextTimedInput>, ((monitor) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((monitor) => Promise<T>)]
Returns Promise<T>
Implementation of Lockable.withF
- Defined in src/Monitor.ts:332

withG

withG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [...(string | RWLockRequest)[], ((monitor) => AsyncGenerator<T, TReturn, TNext>)] | [...(string | RWLockRequest)[], Partial<ContextTimedInput>, ((monitor) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | Partial<ContextTimedInput>, ((monitor) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
Implementation of Lockable.withG
- Defined in src/Monitor.ts:349

Class Monitor<RWLock>

Type Parameters

RWLock extends RWLockReader | RWLockWriter

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

RWLock extends RWLockWriter | RWLockReader

Parameters

lockBox: LockBox<RWLock>

lockConstructor: (new () => RWLock)

Returns RWLock

Optional locksPending: Map<string, { count: number; }>

Returns Monitor<RWLock>

Properties

Protected _locks

Protected lockBox

Protected lockConstructor

Type declaration

Returns RWLock

Protected Optional locksPending

Type declaration

count: number

Accessors

count

Returns number

locks

Returns ReadonlyMap<string, { status: "acquiring"; type: "read" | "write"; } | { lock: RWLock; release: ResourceRelease; status: "acquired"; type: "read" | "write"; }>

Methods

Protected checkForDeadlock

Parameters

key: string

lockType: "read" | "write"

Returns boolean

isLocked

Parameters

Optional key: string

Optional type: "read" | "write"

Returns boolean

lock

Parameters

Rest ...params: (string | RWLockRequest)[] | [...requests: (string | RWLockRequest)[], ctx: Partial<ContextTimedInput>] | [ctx?: Partial<ContextTimedInput>]

Returns ResourceAcquireCancellable<Monitor<RWLock>>

Protected setPendingLock

Parameters

key: string

lockType: "read" | "write"

Returns [string, { count: number; }]

unlock

Parameters

Rest ...keys: string[]

Returns Promise<void>

unlockAll

Returns Promise<void>

Protected unsetPendingLock

Parameters

lockPendingKey: string

lockPending: { count: number; }

count: number

Returns void

waitForUnlock

Parameters

Rest ...params: [] | [key?: string, ctx?: Partial<ContextTimedInput>] | [key?: string] | [ctx?: Partial<ContextTimedInput>]

Returns PromiseCancellable<void>

withF

Type Parameters

T

Parameters

Rest ...params: [...(string | RWLockRequest)[], ((monitor) => Promise<T>)] | [...(string | RWLockRequest)[], Partial<ContextTimedInput>, ((monitor) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((monitor) => Promise<T>)]

Returns Promise<T>

withG

Type Parameters

T

TReturn

`Optional` locksPending: Map<string, {
count: number;
}>

`Protected` _locks

`Protected` lockBox

`Protected` lockConstructor

`Protected` `Optional` locksPending

Returns ReadonlyMap<string, {
status: "acquiring";
type: "read" | "write";
} | {
lock: RWLock;
release: ResourceRelease;
status: "acquired";
type: "read" | "write";
}>

`Protected` checkForDeadlock

`Optional` key: string

`Optional` type: "read" | "write"

`Rest` ...params: (string | RWLockRequest)[] | [...requests: (string | RWLockRequest)[], ctx: Partial<ContextTimedInput>] | [ctx?: Partial<ContextTimedInput>]

`Protected` setPendingLock

Returns [string, {
count: number;
}]

`Rest` ...keys: string[]

`Protected` unsetPendingLock

lockPending: {
count: number;
}

`Rest` ...params: [] | [key?: string, ctx?: Partial<ContextTimedInput>] | [key?: string] | [ctx?: Partial<ContextTimedInput>]

`Rest` ...params: [...(string | RWLockRequest)[], ((monitor) => Promise<T>)] | [...(string | RWLockRequest)[], Partial<ContextTimedInput>, ((monitor) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((monitor) => Promise<T>)]