Package ai.vespa.feed.client

Class GracePeriodCircuitBreaker

java.lang.Object

ai.vespa.feed.client.GracePeriodCircuitBreaker

All Implemented Interfaces:

FeedClient.CircuitBreaker

public class GracePeriodCircuitBreaker
extends Object
implements FeedClient.CircuitBreaker

Breaks the circuit when no successes have been recorded for a specified time.

Author:

jonmv

Nested Class Summary

Nested classes/interfaces inherited from interface ai.vespa.feed.client.FeedClient.CircuitBreaker

FeedClient.CircuitBreaker.State

Field Summary

Fields inherited from interface ai.vespa.feed.client.FeedClient.CircuitBreaker

FUSED

Constructor Summary

Constructors

Constructor	Description
GracePeriodCircuitBreaker(Duration grace)	Creates a new circuit breaker with the given grace periods.
GracePeriodCircuitBreaker(Duration grace, Duration doom)	Creates a new circuit breaker with the given grace periods.

Method Summary

Modifier and Type	Method	Description
void	failure(ai.vespa.feed.client.HttpResponse response)	Called by the client whenever an error HTTP response is received.
void	failure(Throwable cause)	Called by the client whenever an exception occurs trying to obtain a HTTP response.
FeedClient.CircuitBreaker.State	state()	The current state of the circuit breaker.
void	success()	Called by the client whenever a successful response is obtained.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GracePeriodCircuitBreaker

public GracePeriodCircuitBreaker(Duration grace)

Creates a new circuit breaker with the given grace periods.

Parameters:

grace - the period of consecutive failures before state changes to half-open.

GracePeriodCircuitBreaker

public GracePeriodCircuitBreaker(Duration grace,
                                 Duration doom)

Creates a new circuit breaker with the given grace periods.

Parameters:

grace - the period of consecutive failures before state changes to half-open.

doom - the period of consecutive failures before shutting down.

Method Detail

success

public void success()

Description copied from interface: FeedClient.CircuitBreaker

Called by the client whenever a successful response is obtained.

Specified by:

success in interface FeedClient.CircuitBreaker

failure

public void failure(ai.vespa.feed.client.HttpResponse response)

Description copied from interface: FeedClient.CircuitBreaker

Called by the client whenever an error HTTP response is received.

Specified by:

failure in interface FeedClient.CircuitBreaker

failure

public void failure(Throwable cause)

Description copied from interface: FeedClient.CircuitBreaker

Called by the client whenever an exception occurs trying to obtain a HTTP response.

Specified by:

failure in interface FeedClient.CircuitBreaker

state

public FeedClient.CircuitBreaker.State state()

Description copied from interface: FeedClient.CircuitBreaker

The current state of the circuit breaker.

Specified by:

state in interface FeedClient.CircuitBreaker