Class StandardHttpShieldOptions

Namespace

Kevlar.Extensions.Http

Assembly

Kevlar.Extensions.Http.dll

Configures the standard HTTP resilience pipeline and its request handler.

public sealed class StandardHttpShieldOptions

Inheritance

object

StandardHttpShieldOptions

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

StandardHttpShieldOptions()

public StandardHttpShieldOptions()

Properties

AttemptTimeout

Configures the per-attempt timeout. Defaults to 10 seconds. Set InfiniteTimeSpan to omit this stage.

public TimeoutOptions AttemptTimeout { get; set; }

Property Value

TimeoutOptions

CircuitBreaker

Configures the circuit breaker. Defaults to a 50% failure ratio over 30 seconds, with a minimum throughput of 10 and a 15-second break.

public CircuitBreakerOptions<HttpResponseMessage> CircuitBreaker { get; set; }

Property Value

CircuitBreakerOptions<HttpResponseMessage>

ConcurrencyLimit

Optionally configures a concurrency limiter between the circuit breaker and attempt timeout. The limiter is disabled when this property is null.

public ConcurrencyLimitOptions? ConcurrencyLimit { get; set; }

Property Value

ConcurrencyLimitOptions

Handler

Configures request replay and optional endpoint routing.

public ShieldHttpHandlerOptions Handler { get; set; }

Property Value

ShieldHttpHandlerOptions

Retry

Configures transient retries. Defaults to three jittered exponential retries that honour Retry-After headers. Notifications observe the live handled response, which is disposed before the next attempt starts.

public RetryOptions<HttpResponseMessage> Retry { get; set; }

Property Value

RetryOptions<HttpResponseMessage>

TotalTimeout

Configures the outer total timeout. Defaults to 30 seconds. Set InfiniteTimeSpan to omit this stage.

public TimeoutOptions TotalTimeout { get; set; }

Property Value

TimeoutOptions

UseRetryAfterHeader

Whether retry delays honour the response's Retry-After header. Defaults to true and composes with DelayGenerator by using the longer delay.

public bool UseRetryAfterHeader { get; set; }

Property Value

bool