vertx / io.vertx.reactivex.ext.bridge / BaseBridgeEvent

BaseBridgeEvent

open class BaseBridgeEvent : Future<Boolean>

Represents an event that occurs on the event bus bridge.

Please consult the documentation for a full explanation.

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

Constructors

<init>

BaseBridgeEvent(delegate: BaseBridgeEvent)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<BaseBridgeEvent>

Inherited Properties

__typeArg_0

val __typeArg_0: TypeArg<T>

Functions

complete

open fun complete(arg0: Boolean): Unit

completer

open fun completer(): Handler<AsyncResult<Boolean>>

compose

open fun <U : Any> compose(handler: Handler<Boolean>, next: Future<U>): Future<U>
open fun <U : Any> compose(mapper: Function<Boolean, Future<U>>): Future<U>

equals

open fun equals(other: Any?): Boolean

getDelegate

open fun getDelegate(): BaseBridgeEvent

getRawMessage

open fun getRawMessage(): JsonObject

Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved. If the returned message is modified, io.vertx.reactivex.ext.bridge.BaseBridgeEvent#setRawMessage should be called with the new message.

hashCode

open fun hashCode(): Int

map

open fun <U : Any> map(mapper: Function<Boolean, U>): Future<U>

newInstance

open static fun newInstance(arg: BaseBridgeEvent): BaseBridgeEvent

otherwise

open fun otherwise(mapper: Function<Throwable, Boolean>): Future<Boolean>
open fun otherwise(value: Boolean): Future<Boolean>

otherwiseEmpty

open fun otherwiseEmpty(): Future<Boolean>

recover

open fun recover(mapper: Function<Throwable, Future<Boolean>>): Future<Boolean>

result

open fun result(): Boolean

rxSetHandler

open fun rxSetHandler(): Single<Boolean>

setHandler

open fun setHandler(arg0: Handler<AsyncResult<Boolean>>): Future<Boolean>

setRawMessage

open fun setRawMessage(message: JsonObject): BaseBridgeEvent

Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved.

toString

open fun toString(): String

tryComplete

open fun tryComplete(arg0: Boolean): Boolean

type

open fun type(): BridgeEventType

Inherited Functions

cause

open fun cause(): Throwable

A Throwable describing failure. This will be null if the operation succeeded.

complete

open fun complete(): Unit

Set a null result. Any handler will be called, if there is one, and the future will be marked as completed.

fail

open fun fail(cause: Throwable): Unit

Set the failure. Any handler will be called, if there is one, and the future will be marked as completed.

open fun fail(failureMessage: String): Unit

Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed.

failed

open fun failed(): Boolean

Did it fail?

failedFuture

open static fun <T : Any> failedFuture(t: Throwable): Future<T>

Create a failed future with the specified failure cause.

open static fun <T : Any> failedFuture(failureMessage: String): Future<T>

Create a failed future with the specified failure message.

future

open static fun <T : Any> future(handler: Handler<Future<T>>): Future<T>

Create a future that hasn't completed yet and that is passed to the handler before it is returned.

open static fun <T : Any> future(): Future<T>

Create a future that hasn't completed yet

isComplete

open fun isComplete(): Boolean

Has the future completed?

It's completed if it's either succeeded or failed.

map

open fun <V : Any> map(value: V): Future<V>

Map the result of a future to a specific value.

When this future succeeds, this value will complete the future returned by this method call.

When this future fails, the failure will be propagated to the returned future.

mapEmpty

open fun <V : Any> mapEmpty(): Future<V>

Map the result of a future to null.

This is a conveniency for future.map((T) null) or future.map((Void) null).

When this future succeeds, null will complete the future returned by this method call.

When this future fails, the failure will be propagated to the returned future.

newInstance

open static fun <T : Any> newInstance(arg: Future<Any>): Future<T>
open static fun <T : Any> newInstance(arg: Future<Any>, __typeArg_T: TypeArg<T>): Future<T>

succeeded

open fun succeeded(): Boolean

Did it succeed?

succeededFuture

open static fun <T : Any> succeededFuture(): Future<T>

Create a succeeded future with a null result

open static fun <T : Any> succeededFuture(result: T): Future<T>

Created a succeeded future with the specified result.

tryComplete

open fun tryComplete(): Boolean

Try to set the result. When it happens, any handler will be called, if there is one, and the future will be marked as completed.

tryFail

open fun tryFail(failureMessage: String): Boolean
open fun tryFail(cause: Throwable): Boolean

Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed.