An implementation of the circuit breaker pattern for Vert.x
Constructor and description |
---|
CircuitBreaker
(java.lang.Object delegate) |
Type | Name and description | ||
---|---|---|---|
CircuitBreaker |
close() Closes the circuit breaker. |
||
CircuitBreaker |
closeHandler(io.vertx.core.Handler<java.lang.Void> handler) Sets a invoked when the circuit breaker state switches to close. |
||
static CircuitBreaker |
create(java.lang.String name, Vertx vertx, java.util.Map<java.lang.String, java.lang.Object> options) Creates a new instance of CircuitBreaker. |
||
static CircuitBreaker |
create(java.lang.String name, Vertx vertx) Creates a new instance of CircuitBreaker, with default options. |
||
Future<T> |
execute(io.vertx.core.Handler<Future<T>> operation) Same as CircuitBreaker.executeWithFallback but using the circuit breaker default fallback. |
||
CircuitBreaker |
executeAndReport(Future<T> resultFuture, io.vertx.core.Handler<Future<T>> operation) Same as CircuitBreaker.executeAndReportWithFallback but using the circuit breaker default fallback. |
||
CircuitBreaker |
executeAndReportWithFallback(Future<T> resultFuture, io.vertx.core.Handler<Future<T>> operation, java.util.function.Function<java.lang.Throwable, T> fallback) Executes the given operation with the circuit breaker control. |
||
Future<T> |
executeWithFallback(io.vertx.core.Handler<Future<T>> operation, java.util.function.Function<java.lang.Throwable, T> fallback) Executes the given operation with the circuit breaker control. |
||
long |
failureCount()
|
||
CircuitBreaker |
fallback(java.util.function.Function<java.lang.Throwable, T> handler) Sets a default invoked when the bridge is open to handle the "request", or on failure if | java.lang.Object |
getDelegate() |
CircuitBreaker |
halfOpenHandler(io.vertx.core.Handler<java.lang.Void> handler) Sets a invoked when the circuit breaker state switches to half-open. |
||
java.lang.String |
name()
|
||
CircuitBreaker |
open() Explicitly opens the circuit. |
||
CircuitBreaker |
openHandler(io.vertx.core.Handler<java.lang.Void> handler) Sets a invoked when the circuit breaker state switches to open. |
||
CircuitBreaker |
reset() Resets the circuit breaker state (number of failure set to 0 and state set to closed). |
||
CircuitBreakerState |
state()
|
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Closes the circuit breaker. It stops sending events on its state on the event bus.
This method is not related to the close
state of the circuit breaker. To set the circuit breaker in the
close
state, use CircuitBreaker.reset.
Sets a invoked when the circuit breaker state switches to close.
handler
- the handler, must not be null
Creates a new instance of CircuitBreaker.
name
- the namevertx
- the Vert.x instanceoptions
- the configuration option (see CircuitBreakerOptions)Creates a new instance of CircuitBreaker, with default options.
name
- the namevertx
- the Vert.x instanceSame as CircuitBreaker.executeWithFallback but using the circuit breaker default fallback.
operation
- the operationSame as CircuitBreaker.executeAndReportWithFallback but using the circuit breaker default fallback.
resultFuture
- the future on which the operation result is reportedoperation
- the operationExecutes the given operation with the circuit breaker control. The operation is generally calling an external system. The operation receives a object as parameter and must call when the operation has terminated successfully. The operation must also call in case of failure.
The operation is not invoked if the circuit breaker is open, and the given fallback is called immediately. The circuit breaker also monitor the completion of the operation before a configure timeout. The operation is considered as failed if it does not terminate in time.
Unlike CircuitBreaker.executeWithFallback, this method does return a object, but let the caller pass a object on which the result is reported. If the fallback is called, the future is successfully completed with the value returned by the fallback function. If the fallback throws an exception, the future is marked as failed.
resultFuture
- the future on which the operation result is reportedoperation
- the operationfallback
- the fallback function. It gets an exception as parameter and returns the fallback resultExecutes the given operation with the circuit breaker control. The operation is generally calling an external system. The operation receives a object as parameter and must call when the operation has terminated successfully. The operation must also call in case of failure.
The operation is not invoked if the circuit breaker is open, and the given fallback is called immediately. The circuit breaker also monitor the completion of the operation before a configure timeout. The operation is considered as failed if it does not terminate in time.
This method returns a object to retrieve the status and result of the operation, with the status being a success or a failure. If the fallback is called, the returned future is successfully completed with the value returned from the fallback. If the fallback throws an exception, the returned future is marked as failed.
operation
- the operationfallback
- the fallback function. It gets an exception as parameter and returns the fallback result
Sets a default invoked when the bridge is open to handle the "request", or on failure if CircuitBreakerOptions is enabled.
The function gets the exception as parameter and returns the fallback result.
handler
- the handlerSets a invoked when the circuit breaker state switches to half-open.
handler
- the handler, must not be null
Explicitly opens the circuit.
Sets a invoked when the circuit breaker state switches to open.
handler
- the handler, must not be null
Resets the circuit breaker state (number of failure set to 0 and state set to closed).