vertx / io.vertx.reactivex.ext.healthchecks / HealthChecks

HealthChecks

open class HealthChecks

NOTE: This class has been automatically generated from the io.vertx.ext.healthchecks.HealthChecks non RX-ified interface using Vert.x codegen.

Constructors

<init>

HealthChecks(delegate: HealthChecks)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<HealthChecks>

Functions

create

open static fun create(vertx: Vertx): HealthChecks

Creates a new instance of the default implementation of io.vertx.reactivex.ext.healthchecks.HealthChecks.

equals

open fun equals(other: Any?): Boolean

getDelegate

open fun getDelegate(): HealthChecks

hashCode

open fun hashCode(): Int

invoke

open fun invoke(resultHandler: Handler<JsonObject>): HealthChecks

Invokes the registered procedures and computes the outcome.

open fun invoke(name: String, resultHandler: Handler<AsyncResult<JsonObject>>): HealthChecks

Invokes the registered procedure with the given name and sub-procedures. It computes the overall outcome.

newInstance

open static fun newInstance(arg: HealthChecks): HealthChecks

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.reactivex.ext.healthchecks.HealthChecks#register to configure the timeout.

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.

rxInvoke

open fun rxInvoke(name: String): Single<JsonObject>

Invokes the registered procedure with the given name and sub-procedures. It computes the overall outcome.

toString

open fun toString(): String

unregister

open fun unregister(name: String): HealthChecks

Unregisters a procedure.