vertx / io.vertx.ext.healthchecks / HealthCheckHandler

# HealthCheckHandler

`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:

- 204 - status is `UP` but no procedures installed (no payload)
- 200 - status is `UP`, the payload contains the result of the installed procedures
- 503 - status is `DOWN`, the payload contains the result of the installed procedures
- 500 - status is `DOWN`, the payload contains the result of the installed procedures, one of the procedure has failed

Author
Clement Escoffier

### Functions

create | `open static fun create(vertx: Vertx, provider: AuthProvider): HealthCheckHandler` `open static fun create(vertx: Vertx): HealthCheckHandler` Creates an instance of the default implementation of the HealthCheckHandler. This function creates a new instance of HealthChecks.
createWithHealthChecks | `open static fun createWithHealthChecks(hc: HealthChecks, provider: AuthProvider): HealthCheckHandler` `open static fun createWithHealthChecks(hc: HealthChecks): HealthCheckHandler` Creates an instance of the default implementation of the HealthCheckHandler.
register | `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 `#register(String, long, Handler)`. `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.
unregister | `abstract fun unregister(name: String): HealthCheckHandler` Unregisters a procedure.