Interface ClusterHealthCheck

All Superinterfaces:

Handler<Promise<Status>>

public interface ClusterHealthCheck
extends Handler<Promise<Status>>

A helper to create Vert.x cluster HealthChecks procedures.

Author:

Thomas Segismont

Method Summary

Static Methods

Modifier and Type	Method	Description
static ClusterHealthCheck	createProcedure(Vertx vertx)	Like createProcedure(Vertx, boolean) with details set to true.
static ClusterHealthCheck	createProcedure(Vertx vertx, boolean detailed)	Creates a ready-to-use Vert.x cluster HealthChecks procedure.

Methods inherited from interface Handler

handle

Method Details

createProcedure

static ClusterHealthCheck createProcedure(Vertx vertx)

Like createProcedure(Vertx, boolean) with details set to true.

createProcedure

static ClusterHealthCheck createProcedure(Vertx vertx,
 boolean detailed)

Creates a ready-to-use Vert.x cluster HealthChecks procedure.

Parameters:

vertx - the instance of Vert.x, must not be null

detailed - when set to true, Status data will be filled with cluster health details

Returns:

a Vert.x cluster HealthChecks procedure