Class CircuitBreakerConfiguration

Inheritance
object
CircuitBreakerConfiguration
Inherited Members
Namespace: Couchbase.Core.CircuitBreakers
Assembly: Couchbase.NetClient.dll
Syntax
public class CircuitBreakerConfiguration

Constructors

View Source

CircuitBreakerConfiguration()

Declaration
public CircuitBreakerConfiguration()

Fields

View Source

Default

Declaration
public static CircuitBreakerConfiguration Default
Field Value
Type Description
CircuitBreakerConfiguration

Properties

View Source

CanaryTimeout

The timeout for the canary request until it is deemed failed

Declaration
public TimeSpan CanaryTimeout { get; set; }
Property Value
Type Description
TimeSpan
View Source

CompletionCallback

Called on every response to determine if it is successful or not. The default implementation counts SocketException, TimeoutException and TaskCanceledExceptions, RequestCanceledException as failures.

Declaration
public Func<Exception, bool> CompletionCallback { get; set; }
Property Value
Type Description
Func<Exception, bool>
View Source

Enabled

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
bool
View Source

ErrorThresholdPercentage

The percentage of operations that need to fail in a window until the circuit opens.

Declaration
public uint ErrorThresholdPercentage { get; set; }
Property Value
Type Description
uint
View Source

RollingWindow

The rolling time-frame which is used to calculate the error threshold percentage.

Declaration
public TimeSpan RollingWindow { get; set; }
Property Value
Type Description
TimeSpan
View Source

SleepWindow

The initial sleep time after which a canary is sent as a probe.

Declaration
public TimeSpan SleepWindow { get; set; }
Property Value
Type Description
TimeSpan
View Source

VolumeThreshold

The minimum amount of operations to measure before the threshold percentage kicks in.

Declaration
public int VolumeThreshold { get; set; }
Property Value
Type Description
int