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

# register

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

Registers a health check procedure.

The procedure is a taking a of io.vertx.ext.healthchecks.Status as parameter. Procedures are asynchronous, and must complete or fail the given . 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) io.vertx.ext.healthchecks.Status, the procedure outcome is the received status.

This method uses a 1s timeout. Use `io.vertx.rxjava.ext.healthchecks.HealthChecks#register` 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 io.vertx.rxjava.ext.healthchecks.HealthChecks

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

Registers a health check procedure.

The procedure is a taking a of io.vertx.ext.healthchecks.Status as parameter. Procedures are asynchronous, and must complete or fail the given . 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) io.vertx.ext.healthchecks.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 io.vertx.rxjava.ext.healthchecks.HealthChecks