WrappedExpiringLock | Community Solid Server

An implementation of an expiring lock which defines the expiration logic.

ExpiringLock used by a ExpiringResourceLocker for non-atomic operations. Emits an "expired" event when internal timer runs out and calls release function when this happen.

Hierarchy

EventEmitter
- WrappedExpiringLock

Implements

ExpiringLock

Index

Constructors

constructor

Properties

Constructors

constructor

new WrappedExpiringLock(innerLock: Lock, expiration: number): WrappedExpiringLock

- Defined in src/util/locking/WrappedExpiringLock.ts:17
Parameters
- innerLock: Lock
  
  Instance of ResourceLocker to use for acquiring a lock.
- expiration: number
  
  Time in ms after which the lock expires.
Returns WrappedExpiringLock

Properties

Protected Readonly expiration

expiration: number

Protected Readonly innerLock

innerLock: Lock

Protected Readonly logger

logger: Logger = ...

Protected Optional timeoutHandle

timeoutHandle: NodeJS.Timeout

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): WrappedExpiringLock

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WrappedExpiringLock

Private clearTimeout

clearTimeout(): void

- Defined in src/util/locking/WrappedExpiringLock.ts:57
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Implementation of ExpiringLock.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Implementation of ExpiringLock.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

Private expire

expire(): Promise<void>

- Defined in src/util/locking/WrappedExpiringLock.ts:47
Returns Promise<void>

getMaxListeners

getMaxListeners(): number

Implementation of ExpiringLock.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(event: string | symbol): number

Implementation of ExpiringLock.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Implementation of ExpiringLock.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): WrappedExpiringLock

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WrappedExpiringLock

on

on(event: string | symbol, listener: (...args: any[]) => void): WrappedExpiringLock

- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WrappedExpiringLock

once

once(event: string | symbol, listener: (...args: any[]) => void): WrappedExpiringLock

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WrappedExpiringLock

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): WrappedExpiringLock

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WrappedExpiringLock

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): WrappedExpiringLock

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WrappedExpiringLock

rawListeners

rawListeners(event: string | symbol): Function[]

Implementation of ExpiringLock.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

release

release(): Promise<void>

- Defined in src/util/locking/WrappedExpiringLock.ts:34
Release this lock.

Returns Promise<void>

A promise resolving when the release is finished.

removeAllListeners

removeAllListeners(event?: string | symbol): WrappedExpiringLock

Implementation of ExpiringLock.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns WrappedExpiringLock

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): WrappedExpiringLock

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WrappedExpiringLock

renew

renew(): void

- Defined in src/util/locking/WrappedExpiringLock.ts:42
Reset the unlock timer.

Returns void

Private scheduleTimeout

scheduleTimeout(): void

- Defined in src/util/locking/WrappedExpiringLock.ts:61
Returns void

setMaxListeners

setMaxListeners(n: number): WrappedExpiringLock

Implementation of ExpiringLock.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns WrappedExpiringLock

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

innerLock: Lock

expiration: number

Returns WrappedExpiringLock

Properties

Protected Readonly expiration

Protected Readonly innerLock

Protected Readonly logger

Protected Optional timeoutHandle

Static defaultMaxListeners

Readonly Static errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns WrappedExpiringLock

Private clearTimeout

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

Private expire

Returns Promise<void>

getMaxListeners

Returns number

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns WrappedExpiringLock

on

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns WrappedExpiringLock

once

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns WrappedExpiringLock

prependListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void