Class CircuitBreakerSettings

Settings used by CircuitBreaker used internally by the batching journal when executing event batches.

Inheritance
Object
CircuitBreakerSettings
Inherited Members
Namespace: Akka.Persistence.Sql.Common.Journal
Assembly: Akka.Persistence.Sql.Common.dll
Syntax
public sealed class CircuitBreakerSettings

Constructors

| Improve this Doc View Source

CircuitBreakerSettings(Config)

Creates a new instance of the CircuitBreakerSettings from provided HOCON config.

Declaration
public CircuitBreakerSettings(Config config)
Parameters
Type Name Description
Config config

The configuration used to configure the circuit breaker.
Exceptions
Type Condition
ArgumentNullException

This exception is thrown when the specified config is undefined.
| Improve this Doc View Source

CircuitBreakerSettings(Int32, TimeSpan, TimeSpan)

Initializes a new instance of the CircuitBreakerSettings class.

Declaration
public CircuitBreakerSettings(int maxFailures, TimeSpan callTimeout, TimeSpan resetTimeout)
Parameters
Type Name Description
Int32 maxFailures

The maximum number of failures that can happen before the circuit opens.
TimeSpan callTimeout

The maximum time available for operation to execute before CircuitBreaker considers it a failure.
TimeSpan resetTimeout

The amount of time before CircuitBreaker moves into the half-closed state.

Properties

| Improve this Doc View Source

CallTimeout

Maximum time available for operation to execute before CircuitBreaker considers it a failure.

Declaration
public TimeSpan CallTimeout { get; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

MaxFailures

Maximum number of failures that can happen before the circuit opens.

Declaration
public int MaxFailures { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

ResetTimeout

Timeout that has to pass before CircuitBreaker moves into half-closed state, trying to eventually close after sampling an operation.

Declaration
public TimeSpan ResetTimeout { get; }
Property Value
Type Description
TimeSpan

Extension Methods