AcquireLockProperties interface

パッケージ:

@azure/core-amqp

ロックの取得中に指定する必要があるプロパティについて説明します。

プロパティ

abortSignal	ロックの取得を AbortSignalLike 取り消す要求を通知する インターフェイスの実装。 これは、ロックの取得にのみ適用されます。 ロックが取得されると、タスクが呼び出され、 acquire 取り消しできなくなります。 これにより、ロックが取得された場合に acquire() 渡されたタスクの実行は取り消されませんが、タスクが呼び出される前に取り消された場合は実行できなくなります。
timeoutInMs	ロックを取得できる時間 (ミリ秒単位)。 この時間内にロックが取得されない場合、 によって acquire() 返される Promise は Error で拒否されます。

プロパティの詳細

abortSignal

ロックの取得を AbortSignalLike 取り消す要求を通知する インターフェイスの実装。 これは、ロックの取得にのみ適用されます。 ロックが取得されると、タスクが呼び出され、 acquire 取り消しできなくなります。 これにより、ロックが取得された場合に acquire() 渡されたタスクの実行は取り消されませんが、タスクが呼び出される前に取り消された場合は実行できなくなります。

abortSignal: undefined | AbortSignalLike

プロパティ値

undefined | AbortSignalLike

timeoutInMs

ロックを取得できる時間 (ミリ秒単位)。 この時間内にロックが取得されない場合、 によって acquire() 返される Promise は Error で拒否されます。

timeoutInMs: undefined | number

プロパティ値

undefined | number