RetryConfig interface

Package:

@azure/core-amqp

Describes the parameters that need to be configured for the retry operation.

Properties

abortSignal	The AbortSignal associated with the operation being retried on. If this signal is fired during the wait time between retries, then the retry() method will ensure that the wait is abandoned and the retry process gets cancelled. If this signal is fired when the operation is in progress, then the operation is expected to react to it.
connectionHost	The host ".servicebus.windows.net". Used to check network connectivity.
connectionId	The connection identifier. Used in logging information. Extremely useful when multiple connections are logged in the same file.
operation	The operation that needs to be retried.
operationType	The name/type of operation to be performed. Extremely useful in providing better debug logs.
retryOptions	The retry related options associated with given operation execution.

Property Details

abortSignal

The AbortSignal associated with the operation being retried on. If this signal is fired during the wait time between retries, then the retry() method will ensure that the wait is abandoned and the retry process gets cancelled. If this signal is fired when the operation is in progress, then the operation is expected to react to it.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

connectionHost

The host ".servicebus.windows.net". Used to check network connectivity.

connectionHost?: string

Property Value

string

connectionId

The connection identifier. Used in logging information. Extremely useful when multiple connections are logged in the same file.

connectionId: string

Property Value

string

operation

The operation that needs to be retried.

operation: () => Promise<T>

Property Value

() => Promise<T>

operationType

The name/type of operation to be performed. Extremely useful in providing better debug logs.

operationType: RetryOperationType

Property Value

RetryOperationType

retryOptions

The retry related options associated with given operation execution.

retryOptions?: RetryOptions

Property Value

RetryOptions