Ejemplo n.º 1
0
 /// <summary>
 /// <para> Builds a <see cref="Policy"/> that will function like a Circuit Breaker.</para>
 /// <para>The circuit will break if <paramref name="exceptionsAllowedBeforeBreaking"/>
 /// exceptions that are handled by this policy are raised consecutively. </para>
 /// <para>The circuit will stay broken for the <paramref name="durationOfBreak"/>. Any attempt to execute this policy
 /// while the circuit is broken, will immediately throw a <see cref="BrokenCircuitException"/> containing the exception 
 /// that broke the circuit.
 /// </para>
 /// <para>If the first action after the break duration period results in a handled exception, the circuit will break
 /// again for another <paramref name="durationOfBreak"/>; if no exception is thrown, the circuit will reset.
 /// </para>
 /// </summary>
 /// <param name="policyBuilder">The policy builder.</param>
 /// <param name="exceptionsAllowedBeforeBreaking">The number of exceptions that are allowed before opening the circuit.</param>
 /// <param name="durationOfBreak">The duration the circuit will stay open before resetting.</param>
 /// <param name="onBreak">The action to call when the circuit transitions to an <see cref="CircuitState.Open"/> state.</param>
 /// <param name="onReset">The action to call when the circuit resets to a <see cref="CircuitState.Closed"/> state.</param>
 /// <returns>The policy instance.</returns>
 /// <remarks>(see "Release It!" by Michael T. Nygard fi)</remarks>
 /// <exception cref="System.ArgumentOutOfRangeException">exceptionsAllowedBeforeBreaking;Value must be greater than zero.</exception>
 /// <exception cref="ArgumentNullException">onBreak</exception>
 /// <exception cref="ArgumentNullException">onReset</exception>
 public static CircuitBreakerPolicy CircuitBreaker(this PolicyBuilder policyBuilder, int exceptionsAllowedBeforeBreaking, TimeSpan durationOfBreak, Action<Exception, TimeSpan> onBreak, Action onReset)
 {
     return policyBuilder.CircuitBreaker(
         exceptionsAllowedBeforeBreaking, 
         durationOfBreak, 
         (exception, timespan, context) => onBreak(exception, timespan), 
         context => onReset()
         );
 }
Ejemplo n.º 2
0
        /// <summary>
        /// <para> Builds a <see cref="Policy"/> that will function like a Circuit Breaker.</para>
        /// <para>The circuit will break if <paramref name="exceptionsAllowedBeforeBreaking"/>
        /// exceptions that are handled by this policy are raised consecutively. </para>
        /// <para>The circuit will stay broken for the <paramref name="durationOfBreak"/>. Any attempt to execute this policy
        /// while the circuit is broken, will immediately throw a <see cref="BrokenCircuitException"/> containing the exception 
        /// that broke the circuit.
        /// </para>
        /// <para>If the first action after the break duration period results in a handled exception, the circuit will break
        /// again for another <paramref name="durationOfBreak"/>; if no exception is thrown, the circuit will reset.
        /// </para>
        /// </summary>
        /// <param name="policyBuilder">The policy builder.</param>
        /// <param name="exceptionsAllowedBeforeBreaking">The number of exceptions that are allowed before opening the circuit.</param>
        /// <param name="durationOfBreak">The duration the circuit will stay open before resetting.</param>
        /// <returns>The policy instance.</returns>
        /// <remarks>(see "Release It!" by Michael T. Nygard fi)</remarks>
        /// <exception cref="System.ArgumentOutOfRangeException">exceptionsAllowedBeforeBreaking;Value must be greater than zero.</exception>
        /// <exception cref="ArgumentNullException">onBreak</exception>
        /// <exception cref="ArgumentNullException">onReset</exception>
        public static CircuitBreakerPolicy CircuitBreaker(this PolicyBuilder policyBuilder, int exceptionsAllowedBeforeBreaking, TimeSpan durationOfBreak)
        {
            Action<Exception, TimeSpan> doNothingOnBreak = (_, __) => { };
            Action doNothingOnReset = () => { };

            return policyBuilder.CircuitBreaker
                (exceptionsAllowedBeforeBreaking, 
                durationOfBreak, 
                doNothingOnBreak,
                doNothingOnReset
                );
        }
Ejemplo n.º 3
0
 /// <summary>
 /// <para> Builds a <see cref="Policy"/> that will function like a Circuit Breaker.</para>
 /// <para>The circuit will break if <paramref name="exceptionsAllowedBeforeBreaking"/>
 /// exceptions that are handled by this policy are raised consecutively. </para>
 /// <para>The circuit will stay broken for the <paramref name="durationOfBreak"/>. Any attempt to execute this policy
 /// while the circuit is broken, will immediately throw a <see cref="BrokenCircuitException"/> containing the exception 
 /// that broke the circuit.
 /// </para>
 /// <para>If the first action after the break duration period results in a handled exception, the circuit will break
 /// again for another <paramref name="durationOfBreak"/>; if no exception is thrown, the circuit will reset.
 /// </para>
 /// </summary>
 /// <param name="policyBuilder">The policy builder.</param>
 /// <param name="exceptionsAllowedBeforeBreaking">The number of exceptions that are allowed before opening the circuit.</param>
 /// <param name="durationOfBreak">The duration the circuit will stay open before resetting.</param>
 /// <param name="onBreak">The action to call when the circuit transitions to an <see cref="CircuitState.Open"/> state.</param>
 /// <param name="onReset">The action to call when the circuit resets to a <see cref="CircuitState.Closed"/> state.</param>
 /// <returns>The policy instance.</returns>
 /// <remarks>(see "Release It!" by Michael T. Nygard fi)</remarks>
 /// <exception cref="System.ArgumentOutOfRangeException">exceptionsAllowedBeforeBreaking;Value must be greater than zero.</exception>
 /// <exception cref="ArgumentNullException">onBreak</exception>
 /// <exception cref="ArgumentNullException">onReset</exception>
 public static CircuitBreakerPolicy CircuitBreaker(this PolicyBuilder policyBuilder, int exceptionsAllowedBeforeBreaking, TimeSpan durationOfBreak, Action<Exception, TimeSpan, Context> onBreak, Action<Context> onReset)
 {
     Action doNothingOnHalfOpen = () => { };
     return policyBuilder.CircuitBreaker(exceptionsAllowedBeforeBreaking, 
         durationOfBreak, 
         onBreak, 
         onReset,
         doNothingOnHalfOpen
         );
 }