interface HealthCheckHandler : Handler<RoutingContext>
A Vert.x Web handler on which you register health check procedure. It computes the outcome status (`UP` or `DOWN`) . When the handler process a HTTP request, it computes the global outcome and build a HTTP response as follows:
Author
Clement Escoffier
open static fun create(vertx: Vertx, provider: AuthProvider): HealthCheckHandleropen static fun create(vertx: Vertx): HealthCheckHandler
Creates an instance of the default implementation of the HealthCheckHandler. This function creates a new instance of HealthChecks. |
|
open static fun createWithHealthChecks(hc: HealthChecks, provider: AuthProvider): HealthCheckHandleropen static fun createWithHealthChecks(hc: HealthChecks): HealthCheckHandler
Creates an instance of the default implementation of the HealthCheckHandler. |
|
abstract fun register(name: String, procedure: Handler<Future<Status>>): HealthCheckHandler
Registers a health check procedure. The procedure is a Handler taking a Future of Status as parameter. Procedures are asynchronous, and must complete or fail the given Future. If the future object is failed, the procedure outcome is considered as `DOWN`. If the future is completed without any object, the procedure outcome is considered as `UP`. If the future is completed with a (not-null) Status, the procedure outcome is the received status. This method uses a 1s timeout. To configure the timeout use abstract fun register(name: String, timeout: Long, procedure: Handler<Future<Status>>): HealthCheckHandler
Registers a health check procedure. The procedure is a Handler taking a Future of Status as parameter. Procedures are asynchronous, and must complete or fail the given Future. If the future object is failed, the procedure outcome is considered as `DOWN`. If the future is completed without any object, the procedure outcome is considered as `UP`. If the future is completed with a (not-null) Status, the procedure outcome is the received status. |
|
abstract fun unregister(name: String): HealthCheckHandler
Unregisters a procedure. |