-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
ICircuitBreakerPolicy.cs
43 lines (38 loc) · 1.72 KB
/
ICircuitBreakerPolicy.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
using System;
namespace Polly.CircuitBreaker
{
/// <summary>
/// Defines properties and methods common to all circuit-breaker policies.
/// </summary>
public interface ICircuitBreakerPolicy : IsPolicy
{
/// <summary>
/// Gets the state of the underlying circuit.
/// </summary>
CircuitState CircuitState { get; }
/// <summary>
/// Gets the last exception handled by the circuit-breaker.
/// <remarks>This will be null if no exceptions have been handled by the circuit-breaker since the circuit last closed.</remarks>
/// </summary>
Exception LastException { get; }
/// <summary>
/// Isolates (opens) the circuit manually, and holds it in this state until a call to <see cref="CircuitBreakerPolicy.Reset"/> is made.
/// </summary>
void Isolate();
/// <summary>
/// Closes the circuit, and resets any statistics controlling automated circuit-breaking.
/// </summary>
void Reset();
}
/// <summary>
/// Defines properties and methods common to all circuit-breaker policies generic-typed for executions returning results of type <typeparamref name="TResult"/>.
/// </summary>
public interface ICircuitBreakerPolicy<TResult> : ICircuitBreakerPolicy
{
/// <summary>
/// Gets the last result returned from a user delegate which the circuit-breaker handled.
/// <remarks>This will be default(<typeparamref name="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.</remarks>
/// </summary>
TResult LastHandledResult { get; }
}
}