Class TaskLock

任务的加锁服务接口。

当包含任务的服务需要多实例运行时，有些任务可能同时只需要运行一次，此时你可能需要一个加锁服务，来保证任务不会重复执行。

Hierarchy

TaskLock

Index

Constructors

constructor

Methods

Constructors

constructor

new TaskLock(): TaskLock

Returns TaskLock

Methods

Abstract lock

lock(key: string, context: TaskContext): Promise<undefined | null | string | boolean>

- Defined in src/service/task-lock.ts:29
加锁接口。
- 返回 undefined 表示加锁失败。
- 其余情况表示加锁成功，继而执行任务。之后会将返回值传递到 TaskLock.unlock 进行解锁。
Parameters
- key: string
  
  通过 Tora.Lock 设置的 key。
- context: TaskContext
  
  任务上下文对象。
Returns Promise<undefined | null | string | boolean>

普通状况下直接使用 key 进行加锁和解锁。如果有更高的安全需求，可以生成 secret 来避免错误解锁。

Abstract on_lock_failed

on_lock_failed(context: TaskContext): Promise<void>

- Defined in src/service/task-lock.ts:45
对于加锁失败的情况，会触发这个函数。

Parameters
- context: TaskContext
  
  任务上下文对象。
Returns Promise<void>

Abstract unlock

unlock(key: string, secret: undefined | null | string | boolean, context: TaskContext): Promise<void>

- Defined in src/service/task-lock.ts:38
解锁接口。

Parameters
- key: string
  
  通过 Tora.Lock 设置的 key。
- secret: undefined | null | string | boolean
  
  TaskLock.lock 的执行结果。
- context: TaskContext
  
  任务上下文对象。
Returns Promise<void>

Generated using TypeDoc