Class LockManager

Hierarchy

LockManager

Index

Constructors

Properties

_runtimeConfig databaseManager lockDatabase?

Methods

acquireLock extendLock generateLockKey getLockDatabase getLockInfo releaseLock setDatabase

Constructors

constructor

new LockManager(_runtimeConfig: RuntimeConfig, databaseManager: InMemoryDatabaseManager): LockManager
Parameters
- _runtimeConfig: RuntimeConfig
- databaseManager: InMemoryDatabaseManager
Returns LockManager
- Defined in src/services/LockManager.ts:20

Properties

`Protected` _runtimeConfig

_runtimeConfig: RuntimeConfig

`Protected` databaseManager

databaseManager: InMemoryDatabaseManager

`Private` `Optional` lockDatabase

lockDatabase?: InMemoryDatabase

Methods

acquireLock

acquireLock(entityId: string, byUser: string, expireSeconds: number): Promise<void>
Locks entity
Parameters
- entityId: string
- byUser: string
- expireSeconds: number
Returns Promise<void>
- Defined in src/services/LockManager.ts:34

extendLock

extendLock(entityId: string, byUser: string, expireSeconds: number): Promise<void>
Prolongs existing lock

The caller should first check that the user actually holds the lock.
Parameters
- entityId: string
- byUser: string
  
  user id
- expireSeconds: number
  
  expire time in seconds (replaces existing)
Returns Promise<void>
- Defined in src/services/LockManager.ts:87

`Private` generateLockKey

generateLockKey(entityId: string): string
Parameters
- entityId: string
Returns string
- Defined in src/services/LockManager.ts:103

`Private` getLockDatabase

getLockDatabase(): InMemoryDatabase
Returns InMemoryDatabase
- Defined in src/services/LockManager.ts:98

getLockInfo

getLockInfo(entityId: string): Promise<LockInfo>
Returns information about existed lock
Parameters
- entityId: string
Returns Promise<LockInfo>
- Defined in src/services/LockManager.ts:63

releaseLock

releaseLock(entityId: string): Promise<boolean>
Unlocks entity
Parameters
- entityId: string
Returns Promise<boolean>
- Defined in src/services/LockManager.ts:52

setDatabase

setDatabase(database: string | InMemoryDatabase): void
Parameters
- database: string | InMemoryDatabase
Returns void
- Defined in src/services/LockManager.ts:27

Generated using TypeDoc