Class HealthChecks
- java.lang.Object
-
- io.vertx.reactivex.ext.healthchecks.HealthChecks
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<HealthChecks>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description HealthChecks(HealthChecks delegate)HealthChecks(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Future<CheckResult>checkStatus()Invokes the registered procedures.Future<CheckResult>checkStatus(String name)Invokes the registered procedure with the given name and sub-procedures.static HealthCheckscreate(Vertx vertx)Creates a new instance of the default implementation ofHealthChecks.booleanequals(Object o)HealthChecksgetDelegate()inthashCode()HealthChecksinvoke(Handler<JsonObject> resultHandler)Invokes the registered procedures and computes the outcome.Future<JsonObject>invoke(String name)Invokes the registered procedure with the given name and sub-procedures.static HealthChecksnewInstance(HealthChecks arg)HealthChecksregister(String name, long timeout, Handler<Promise<Status>> procedure)Registers a health check procedure.HealthChecksregister(String name, 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.StringtoString()HealthChecksunregister(String name)Unregisters a procedure.
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<HealthChecks> __TYPE_ARG
-
-
Constructor Detail
-
HealthChecks
public HealthChecks(HealthChecks delegate)
-
HealthChecks
public HealthChecks(Object delegate)
-
-
Method Detail
-
getDelegate
public HealthChecks getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
create
public static HealthChecks create(Vertx vertx)
Creates a new instance of the default implementation ofHealthChecks.- Parameters:
vertx- the instance of Vert.x, must not benull- Returns:
- the created instance
-
register
public HealthChecks register(String name, Handler<Promise<Status>> procedure)
Registers a health check procedure.The procedure is a taking a of
Statusas 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.reactivex.core.Promise<io.vertx.ext.healthchecks.Status>>)to configure the timeout.- Parameters:
name- the name of the procedure, must not benullor emptyprocedure- the procedure, must not benull- Returns:
- the current
HealthChecks
-
register
public HealthChecks register(String name, long timeout, Handler<Promise<Status>> procedure)
Registers a health check procedure.The procedure is a taking a of
Statusas 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.- Parameters:
name- the name of the procedure, must not benullor emptytimeout- the procedure timeout in millisecondsprocedure- the procedure, must not benull- Returns:
- the current
HealthChecks
-
unregister
public HealthChecks unregister(String name)
Unregisters a procedure.- Parameters:
name- the name of the procedure- Returns:
- the current
HealthChecks
-
invoke
public HealthChecks invoke(Handler<JsonObject> resultHandler)
Invokes the registered procedures and computes the outcome.- Parameters:
resultHandler- the result handler, must not benull. The handler received the computed .- Returns:
- the current
HealthChecks
-
invoke
public Future<JsonObject> invoke(String name)
Invokes the registered procedure with the given name and sub-procedures. It computes the overall outcome.- Parameters:
name-- Returns:
- a future notified with a failure if the procedure with the given name cannot be found or invoked.
-
rxInvoke
public Single<JsonObject> rxInvoke(String name)
Invokes the registered procedure with the given name and sub-procedures. It computes the overall outcome.- Parameters:
name-- Returns:
- a future notified with a failure if the procedure with the given name cannot be found or invoked.
-
checkStatus
public Future<CheckResult> checkStatus()
Invokes the registered procedures.- Returns:
- a future notified with the computed
CheckResult.
-
rxCheckStatus
public Single<CheckResult> rxCheckStatus()
Invokes the registered procedures.- Returns:
- a future notified with the computed
CheckResult.
-
checkStatus
public Future<CheckResult> checkStatus(String name)
Invokes the registered procedure with the given name and sub-procedures.- Parameters:
name-- Returns:
- a future notified with a failure if the procedure with the given name cannot be found or invoked.
-
rxCheckStatus
public Single<CheckResult> rxCheckStatus(String name)
Invokes the registered procedure with the given name and sub-procedures.- Parameters:
name-- Returns:
- a future notified with a failure if the procedure with the given name cannot be found or invoked.
-
newInstance
public static HealthChecks newInstance(HealthChecks arg)
-
-