Class CircuitBreakerPolicy<TResult>

Namespace

Polly.CircuitBreaker

Assembly

Polly.dll

A circuit-breaker policy that can be applied to delegates returning a value of type TResult.

public class CircuitBreakerPolicy<TResult> : Policy<TResult>, IAsyncPolicy<TResult>, ISyncPolicy<TResult>, ICircuitBreakerPolicy<TResult>, ICircuitBreakerPolicy, IsPolicy

Type Parameters

TResult

Inheritance

object

Policy<TResult>

CircuitBreakerPolicy<TResult>

Implements

IAsyncPolicy<TResult>

ISyncPolicy<TResult>

ICircuitBreakerPolicy<TResult>

ICircuitBreakerPolicy

IsPolicy

Inherited Members

Policy<TResult>.Handle<TException>()

Policy<TResult>.Handle<TException>(Func<TException, bool>)

Policy<TResult>.HandleResult(Func<TResult, bool>)

Policy<TResult>.HandleResult(TResult)

Policy<TResult>.WithPolicyKey(string)

Policy<TResult>.ExecuteAsync(Func<Task<TResult>>)

Policy<TResult>.ExecuteAsync(Func<Task<TResult>>, bool)

Policy<TResult>.ExecuteAsync(Func<Task<TResult>>, IDictionary<string, object>)

Policy<TResult>.ExecuteAsync(Func<Task<TResult>>, Context)

Policy<TResult>.ExecuteAsync(Func<Context, Task<TResult>>, IDictionary<string, object>)

Policy<TResult>.ExecuteAsync(Func<Context, Task<TResult>>, Context)

Policy<TResult>.ExecuteAsync(Func<Task<TResult>>, IDictionary<string, object>, bool)

Policy<TResult>.ExecuteAsync(Func<Task<TResult>>, Context, bool)

Policy<TResult>.ExecuteAsync(Func<Context, Task<TResult>>, IDictionary<string, object>, bool)

Policy<TResult>.ExecuteAsync(Func<Context, Task<TResult>>, Context, bool)

Policy<TResult>.ExecuteAsync(Func<CancellationToken, Task<TResult>>, CancellationToken)

Policy<TResult>.ExecuteAsync(Func<CancellationToken, Task<TResult>>, CancellationToken, bool)

Policy<TResult>.ExecuteAsync(Func<CancellationToken, Task<TResult>>, IDictionary<string, object>, CancellationToken)

Policy<TResult>.ExecuteAsync(Func<CancellationToken, Task<TResult>>, Context, CancellationToken)

Policy<TResult>.ExecuteAsync(Func<Context, CancellationToken, Task<TResult>>, IDictionary<string, object>, CancellationToken)

Policy<TResult>.ExecuteAsync(Func<Context, CancellationToken, Task<TResult>>, Context, CancellationToken)

Policy<TResult>.ExecuteAsync(Func<CancellationToken, Task<TResult>>, IDictionary<string, object>, CancellationToken, bool)

Policy<TResult>.ExecuteAsync(Func<CancellationToken, Task<TResult>>, Context, CancellationToken, bool)

Policy<TResult>.ExecuteAsync(Func<Context, CancellationToken, Task<TResult>>, IDictionary<string, object>, CancellationToken, bool)

Policy<TResult>.ExecuteAsync(Func<Context, CancellationToken, Task<TResult>>, Context, CancellationToken, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Task<TResult>>)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Task<TResult>>, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Task<TResult>>, IDictionary<string, object>)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Task<TResult>>, Context)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Context, Task<TResult>>, IDictionary<string, object>)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Context, Task<TResult>>, Context)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Task<TResult>>, IDictionary<string, object>, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Task<TResult>>, Context, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Context, Task<TResult>>, IDictionary<string, object>, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Context, Task<TResult>>, Context, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<CancellationToken, Task<TResult>>, CancellationToken)

Policy<TResult>.ExecuteAndCaptureAsync(Func<CancellationToken, Task<TResult>>, CancellationToken, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<CancellationToken, Task<TResult>>, IDictionary<string, object>, CancellationToken)

Policy<TResult>.ExecuteAndCaptureAsync(Func<CancellationToken, Task<TResult>>, Context, CancellationToken)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Context, CancellationToken, Task<TResult>>, IDictionary<string, object>, CancellationToken)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Context, CancellationToken, Task<TResult>>, Context, CancellationToken)

Policy<TResult>.ExecuteAndCaptureAsync(Func<CancellationToken, Task<TResult>>, IDictionary<string, object>, CancellationToken, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<CancellationToken, Task<TResult>>, Context, CancellationToken, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Context, CancellationToken, Task<TResult>>, IDictionary<string, object>, CancellationToken, bool)

Policy<TResult>.ExecuteAndCaptureAsync(Func<Context, CancellationToken, Task<TResult>>, Context, CancellationToken, bool)

Policy<TResult>.Execute(Func<TResult>)

Policy<TResult>.Execute(Func<TResult>, IDictionary<string, object>)

Policy<TResult>.Execute(Func<TResult>, Context)

Policy<TResult>.Execute(Func<Context, TResult>, IDictionary<string, object>)

Policy<TResult>.Execute(Func<Context, TResult>, Context)

Policy<TResult>.Execute(Func<CancellationToken, TResult>, CancellationToken)

Policy<TResult>.Execute(Func<CancellationToken, TResult>, IDictionary<string, object>, CancellationToken)

Policy<TResult>.Execute(Func<CancellationToken, TResult>, Context, CancellationToken)

Policy<TResult>.Execute(Func<Context, CancellationToken, TResult>, IDictionary<string, object>, CancellationToken)

Policy<TResult>.Execute(Func<Context, CancellationToken, TResult>, Context, CancellationToken)

Policy<TResult>.ExecuteAndCapture(Func<TResult>)

Policy<TResult>.ExecuteAndCapture(Func<TResult>, IDictionary<string, object>)

Policy<TResult>.ExecuteAndCapture(Func<TResult>, Context)

Policy<TResult>.ExecuteAndCapture(Func<Context, TResult>, IDictionary<string, object>)

Policy<TResult>.ExecuteAndCapture(Func<Context, TResult>, Context)

Policy<TResult>.ExecuteAndCapture(Func<CancellationToken, TResult>, CancellationToken)

Policy<TResult>.ExecuteAndCapture(Func<CancellationToken, TResult>, IDictionary<string, object>, CancellationToken)

Policy<TResult>.ExecuteAndCapture(Func<CancellationToken, TResult>, Context, CancellationToken)

Policy<TResult>.ExecuteAndCapture(Func<Context, CancellationToken, TResult>, IDictionary<string, object>, CancellationToken)

Policy<TResult>.ExecuteAndCapture(Func<Context, CancellationToken, TResult>, Context, CancellationToken)

Policy<TResult>.Wrap(Policy)

Policy<TResult>.Wrap(Policy<TResult>)

Policy<TResult>.WrapAsync(Policy)

Policy<TResult>.WrapAsync(Policy<TResult>)

Policy<TResult>.PolicyKey

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

CircuitState

Gets the state of the underlying circuit.

public CircuitState CircuitState { get; }

Property Value

CircuitState

LastException

Gets the last exception handled by the circuit-breaker. This will be null if no exceptions have been handled by the circuit-breaker since the circuit last closed, or if the last event handled by the circuit was a handled TResult value.

public Exception LastException { get; }

Property Value

Exception

LastHandledResult

Gets the last result returned from a user delegate which the circuit-breaker handled. This will be default(TResult) if no results have been handled by the circuit-breaker since the circuit last closed, or if the last event handled by the circuit was an exception.

public TResult LastHandledResult { get; }

Property Value

TResult

Methods

Isolate()

Isolates (opens) the circuit manually, and holds it in this state until a call to Reset() is made.

public void Isolate()

Reset()

Closes the circuit, and resets any statistics controlling automated circuit-breaking.

public void Reset()