Struct HedgingActionGeneratorArguments<TResult>

Namespace

Polly.Hedging

Assembly

Polly.Core.dll

Represents arguments used in the hedging resilience strategy.

public readonly struct HedgingActionGeneratorArguments<TResult>

Type Parameters

TResult

The type of the result.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.

Constructors

HedgingActionGeneratorArguments(ResilienceContext, ResilienceContext, int, Func<ResilienceContext, ValueTask<Outcome<TResult>>>)

Initializes a new instance of the HedgingActionGeneratorArguments<TResult> struct.

public HedgingActionGeneratorArguments(ResilienceContext primaryContext, ResilienceContext actionContext, int attemptNumber, Func<ResilienceContext, ValueTask<Outcome<TResult>>> callback)

Parameters

primaryContext ResilienceContext

The primary resilience context.

actionContext ResilienceContext

The context that will be passed to action generated by ActionGenerator. .

attemptNumber int

The zero-based hedging attempt number.

callback Func<ResilienceContext, ValueTask<Outcome<TResult>>>

The callback passed to hedging strategy.

Properties

ActionContext

Gets the context that will be passed to action generated by ActionGenerator.

public ResilienceContext ActionContext { get; }

Property Value

ResilienceContext

Remarks

This context is cloned from PrimaryContext.

AttemptNumber

Gets the zero-based hedging attempt number.

public int AttemptNumber { get; }

Property Value

int

Callback

Gets the callback passed to hedging strategy.

public Func<ResilienceContext, ValueTask<Outcome<TResult>>> Callback { get; }

Property Value

Func<ResilienceContext, ValueTask<Outcome<TResult>>>

PrimaryContext

Gets the primary resilience context.

public ResilienceContext PrimaryContext { get; }

Property Value

ResilienceContext