vertx / io.vertx.ext.healthchecks / HealthChecks / register

# register

`abstract fun register(name: String, procedure: Handler<Future<Status>>): HealthChecks`

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. Use `#register(String, long, Handler)` to configure the timeout.

### Parameters

`name` - the name of the procedure, must not be `null` or empty

`procedure` - the procedure, must not be `null`

Return
the current HealthChecks

`abstract fun register(name: String, timeout: Long, procedure: Handler<Future<Status>>): HealthChecks`

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.

### Parameters

`name` - the name of the procedure, must not be `null` or empty

`timeout` - the procedure timeout in milliseconds

`procedure` - the procedure, must not be `null`

Return
the current HealthChecks