| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<HealthChecks> |
__TYPE_ARG |
| Constructor and Description |
|---|
HealthChecks(HealthChecks delegate) |
HealthChecks(Object delegate) |
| Modifier and Type | Method and Description |
|---|---|
Single<CheckResult> |
checkStatus()
Invokes the registered procedures.
|
Single<CheckResult> |
checkStatus(String name)
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. |
boolean |
equals(Object o) |
HealthChecks |
getDelegate() |
int |
hashCode() |
HealthChecks |
invoke(Handler<JsonObject> resultHandler)
Invokes the registered procedures and computes the outcome.
|
Single<JsonObject> |
invoke(String name)
Invokes the registered procedure with the given name and sub-procedures.
|
static HealthChecks |
newInstance(HealthChecks arg) |
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.
|
Single<CheckResult> |
rxCheckStatus()
Invokes the registered procedures.
|
Single<CheckResult> |
rxCheckStatus(String name)
Invokes the registered procedure with the given name and sub-procedures.
|
Single<JsonObject> |
rxInvoke(String name)
Invokes the registered procedure with the given name and sub-procedures.
|
String |
toString() |
HealthChecks |
unregister(String name)
Unregisters a procedure.
|
public static final io.vertx.lang.rx.TypeArg<HealthChecks> __TYPE_ARG
public HealthChecks(HealthChecks delegate)
public HealthChecks(Object delegate)
public HealthChecks getDelegate()
public static HealthChecks create(Vertx vertx)
HealthChecks.vertx - the instance of Vert.x, must not be nullpublic HealthChecks register(String name, Handler<Promise<Status>> procedure)
The procedure is a taking a of 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) Status, the procedure outcome is the received status.
This method uses a 1s timeout. Use register(java.lang.String, io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<io.vertx.ext.healthchecks.Status>>) to configure the timeout.
name - the name of the procedure, must not be null or emptyprocedure - the procedure, must not be nullHealthCheckspublic HealthChecks register(String name, long timeout, Handler<Promise<Status>> procedure)
The procedure is a taking a of 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) Status, the procedure outcome is the received status.
name - the name of the procedure, must not be null or emptytimeout - the procedure timeout in millisecondsprocedure - the procedure, must not be nullHealthCheckspublic HealthChecks unregister(String name)
name - the name of the procedureHealthCheckspublic HealthChecks invoke(Handler<JsonObject> resultHandler)
resultHandler - the result handler, must not be null. The handler received the computed .HealthCheckspublic Single<JsonObject> invoke(String name)
name - HealthCheckspublic Single<JsonObject> rxInvoke(String name)
name - HealthCheckspublic Single<CheckResult> checkStatus()
public Single<CheckResult> rxCheckStatus()
public Single<CheckResult> checkStatus(String name)
name - public Single<CheckResult> rxCheckStatus(String name)
name - public static HealthChecks newInstance(HealthChecks arg)
Copyright © 2023 Eclipse. All rights reserved.