Class FallbackTResultSyntax

Namespace

Polly

Assembly

Polly.dll

Fluent API for defining a Fallback Policy.

public static class FallbackTResultSyntax

Inheritance

object

FallbackTResultSyntax

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Fallback<TResult>(PolicyBuilder<TResult>, Func<Context, CancellationToken, TResult>, Action<DelegateResult<TResult>, Context>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result and the execution context; then calls fallbackAction and returns its result.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<Context, CancellationToken, TResult> fallbackAction, Action<DelegateResult<TResult>, Context> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<Context, CancellationToken, TResult>

The fallback action.

onFallback Action<DelegateResult<TResult>, Context>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

ArgumentNullException

onFallback

Fallback<TResult>(PolicyBuilder<TResult>, Func<Context, TResult>, Action<DelegateResult<TResult>, Context>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result and the execution context; then calls fallbackAction and returns its result.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<Context, TResult> fallbackAction, Action<DelegateResult<TResult>, Context> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<Context, TResult>

The fallback action.

onFallback Action<DelegateResult<TResult>, Context>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

ArgumentNullException

onFallback

Fallback<TResult>(PolicyBuilder<TResult>, Func<DelegateResult<TResult>, Context, CancellationToken, TResult>, Action<DelegateResult<TResult>, Context>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result and the execution context; then calls fallbackAction and returns its result.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<DelegateResult<TResult>, Context, CancellationToken, TResult> fallbackAction, Action<DelegateResult<TResult>, Context> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<DelegateResult<TResult>, Context, CancellationToken, TResult>

The fallback action.

onFallback Action<DelegateResult<TResult>, Context>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

ArgumentNullException

onFallback

Fallback<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, TResult>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, calls fallbackAction and returns its result.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<CancellationToken, TResult> fallbackAction)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<CancellationToken, TResult>

The fallback action.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

Fallback<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, TResult>, Action<DelegateResult<TResult>, Context>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result and the execution context; then calls fallbackAction and returns its result.

[Obsolete("This overload is deprecated and will be removed in a future release. Prefer the overload in which both fallbackAction and onFallback take a Context input parameter.")]
public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<CancellationToken, TResult> fallbackAction, Action<DelegateResult<TResult>, Context> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<CancellationToken, TResult>

The fallback action.

onFallback Action<DelegateResult<TResult>, Context>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

ArgumentNullException

onFallback

Fallback<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, TResult>, Action<DelegateResult<TResult>>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result; then calls fallbackAction and returns its result.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<CancellationToken, TResult> fallbackAction, Action<DelegateResult<TResult>> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<CancellationToken, TResult>

The fallback action.

onFallback Action<DelegateResult<TResult>>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

ArgumentNullException

onFallback

Fallback<TResult>(PolicyBuilder<TResult>, Func<TResult>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, calls fallbackAction and returns its result.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<TResult> fallbackAction)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<TResult>

The fallback action.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

Fallback<TResult>(PolicyBuilder<TResult>, Func<TResult>, Action<DelegateResult<TResult>, Context>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result and the execution context; then calls fallbackAction and returns its result.

[Obsolete("This overload is deprecated and will be removed in a future release. Prefer the overload in which both fallbackAction and onFallback take a Context input parameter.")]
public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<TResult> fallbackAction, Action<DelegateResult<TResult>, Context> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<TResult>

The fallback action.

onFallback Action<DelegateResult<TResult>, Context>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

ArgumentNullException

onFallback

Fallback<TResult>(PolicyBuilder<TResult>, Func<TResult>, Action<DelegateResult<TResult>>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result; then calls fallbackAction and returns its result.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, Func<TResult> fallbackAction, Action<DelegateResult<TResult>> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackAction Func<TResult>

The fallback action.

onFallback Action<DelegateResult<TResult>>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

fallbackAction

ArgumentNullException

onFallback

Fallback<TResult>(PolicyBuilder<TResult>, TResult)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, returns fallbackValue instead.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, TResult fallbackValue)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackValue TResult

The fallback TResult value to provide.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Fallback<TResult>(PolicyBuilder<TResult>, TResult, Action<DelegateResult<TResult>, Context>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result and the execution context; then returns fallbackValue.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, TResult fallbackValue, Action<DelegateResult<TResult>, Context> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackValue TResult

The fallback TResult value to provide.

onFallback Action<DelegateResult<TResult>, Context>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

onFallback

Fallback<TResult>(PolicyBuilder<TResult>, TResult, Action<DelegateResult<TResult>>)

Builds a FallbackPolicy which provides a fallback value if the main execution fails. Executes the main delegate, but if this throws a handled exception or raises a handled result, first calls onFallback with details of the handled exception or result; then returns fallbackValue.

public static FallbackPolicy<TResult> Fallback<TResult>(this PolicyBuilder<TResult> policyBuilder, TResult fallbackValue, Action<DelegateResult<TResult>> onFallback)

Parameters

policyBuilder PolicyBuilder<TResult>

The policy builder.

fallbackValue TResult

The fallback TResult value to provide.

onFallback Action<DelegateResult<TResult>>

The action to call before invoking the fallback delegate.

Returns

FallbackPolicy<TResult>

The policy instance.

Type Parameters

TResult

Exceptions

ArgumentNullException

onFallback