HealthChecks (Vert.x Stack - Docs 4.5.11 API)

```
public interface HealthChecks
```
Author:

Clement Escoffier

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Future<CheckResult>`	`checkStatus()` Like `checkStatus(Handler)` but returns a `Future` of the asynchronous result
`void`	`checkStatus(Handler<AsyncResult<CheckResult>> resultHandler)` Invokes the registered procedures.
`Future<CheckResult>`	`checkStatus(String name)` Like `checkStatus(String, Handler)` but returns a `Future` of the asynchronous result
`void`	`checkStatus(String name, Handler<AsyncResult<CheckResult>> resultHandler)` Invokes the registered procedure with the given name and sub-procedures.
`static HealthChecks`	`create(Vertx vertx)` Creates a new instance of the default implementation of `HealthChecks`.
`HealthChecks`	`invoke(Handler<JsonObject> resultHandler)` Invokes the registered procedures and computes the outcome.
`Future<JsonObject>`	`invoke(String name)` Like `invoke(String, Handler)` but with a future of the result.
`HealthChecks`	`invoke(String name, Handler<AsyncResult<JsonObject>> resultHandler)` Invokes the registered procedure with the given name and sub-procedures.
`HealthChecks`	`register(String name, Handler<Promise<Status>> procedure)` Registers a health check procedure.
`HealthChecks`	`register(String name, long timeout, Handler<Promise<Status>> procedure)` Registers a health check procedure.
`HealthChecks`	`unregister(String name)` Unregisters a procedure.

- Method Detail
  - create
```
static HealthChecks create(Vertx vertx)
```
    Creates a new instance of the default implementation of HealthChecks.
    
    Parameters:
    
    vertx - the instance of Vert.x, must not be null
    
    Returns:
    
    the created instance
  - register
```
HealthChecks register(String name,
                      Handler<Promise<Status>> procedure)
```
    Registers a health check procedure.
    The procedure is a Handler taking a Promise of Status as parameter. Procedures are asynchronous, and must complete or fail the given Promise. 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
    
    Returns:
    
    the current HealthChecks
  - register
```
HealthChecks register(String name,
                      long timeout,
                      Handler<Promise<Status>> procedure)
```
    Registers a health check procedure.
    The procedure is a Handler taking a Promise of Status as parameter. Procedures are asynchronous, and must complete or fail the given Promise. 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
    
    Returns:
    
    the current HealthChecks
  - unregister
```
HealthChecks unregister(String name)
```
    Unregisters a procedure.
    
    Parameters:
    
    name - the name of the procedure
    
    Returns:
    
    the current HealthChecks
  - invoke
```
HealthChecks invoke(Handler<JsonObject> resultHandler)
```
    Invokes the registered procedures and computes the outcome.
    
    Parameters:
    
    resultHandler - the result handler, must not be null. The handler received the computed JsonObject.
    
    Returns:
    
    the current HealthChecks
  - invoke
```
HealthChecks invoke(String name,
                    Handler<AsyncResult<JsonObject>> resultHandler)
```
    Invokes the registered procedure with the given name and sub-procedures. It computes the overall outcome.
    
    Parameters:
    
    resultHandler - the result handler, must not be null. The handler received an AsyncResult marked as failed if the procedure with the given name cannot be found or invoked.
    
    Returns:
    
    the current HealthChecks
  - invoke
```
Future<JsonObject> invoke(String name)
```
    Like invoke(String, Handler) but with a future of the result.
  - checkStatus
```
void checkStatus(Handler<AsyncResult<CheckResult>> resultHandler)
```
    Invokes the registered procedures.
    
    Parameters:
    
    resultHandler - the result handler, must not be null. The handler received the computed CheckResult.
  - checkStatus
```
Future<CheckResult> checkStatus()
```
    Like checkStatus(Handler) but returns a Future of the asynchronous result
  - checkStatus
```
void checkStatus(String name,
                 Handler<AsyncResult<CheckResult>> resultHandler)
```
    Invokes the registered procedure with the given name and sub-procedures.
    
    Parameters:
    
    resultHandler - the result handler, must not be null. The handler received an AsyncResult marked as failed if the procedure with the given name cannot be found or invoked.
  - checkStatus
```
Future<CheckResult> checkStatus(String name)
```
    Like checkStatus(String, Handler) but returns a Future of the asynchronous result

Interface HealthChecks

Method Summary

Method Detail

create

register

register

unregister

invoke

invoke

invoke

checkStatus

checkStatus

checkStatus

checkStatus