Represents an event that occurs on the event bus bridge.

Please consult the documentation for a full explanation.

  • BridgeEvent
    • BaseBridgeEvent
      • Future
        • Basic
          • Identifiable
          • Object
            • Anything

no subtypes hierarchy

Initializer
BridgeEvent(BridgeEvent unknown)
Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
completeshared actual default void complete(Boolean arg0)
completershared actual default Anything(Throwable|Boolean) completer()
Refines BaseBridgeEvent.completer ultimately refines Future.completer
composeshared actual default Future<U?> compose<U>(Future<U?>(Boolean) mapper)

Compose this future with a mapper function.

When this future (the one on which compose is called) succeeds, the mapper will be called with the completed value and this mapper returns another future object. This returned future completion will complete the future returned by this method call.

If the mapper throws an exception, the returned future will be failed with this exception.

When this future fails, the failure will be propagated to the returned future and the mapper will not be called.

Refines BaseBridgeEvent.compose ultimately refines Future.compose
composeshared actual default Future<U?> compose<U>(Anything(Boolean) handler, Future<U?> next)

Compose this future with a provided next future.

When this (the one on which compose is called) future succeeds, the handler will be called with the completed value, this handler should complete the next future.

If the handler throws an exception, the returned future will be failed with this exception.

When this future fails, the failure will be propagated to the next future and the handler will not be called.

Refines BaseBridgeEvent.compose ultimately refines Future.compose
mapshared actual default Future<U?> map<U>(U?(Boolean) mapper)

Apply a mapper function on this future.

When this future succeeds, the mapper will be called with the completed value and this mapper returns a value. This value will complete the future returned by this method call.

If the mapper throws an exception, the returned future will be failed with this exception.

When this future fails, the failure will be propagated to the returned future and the mapper will not be called.

Refines BaseBridgeEvent.map ultimately refines Future.map
otherwiseshared actual default Future<Boolean> otherwise(Boolean value)
otherwiseshared actual default Future<Boolean> otherwise(Boolean(Throwable) mapper)

Apply a mapper function on this future.

When this future fails, the mapper will be called with the completed value and this mapper returns a value. This value will complete the future returned by this method call.

If the mapper throws an exception, the returned future will be failed with this exception.

When this future succeeds, the result will be propagated to the returned future and the mapper will not be called.

Refines BaseBridgeEvent.otherwise ultimately refines Future.otherwise
otherwiseEmptyshared actual default Future<Boolean> otherwiseEmpty()

Map the failure of a future to null.

This is a convenience for future.otherwise((T) null).

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

When this future succeeds, the result will be propagated to the returned future.

Refines BaseBridgeEvent.otherwiseEmpty ultimately refines Future.otherwiseEmpty
recovershared actual default Future<Boolean> recover(Future<Boolean>(Throwable) mapper)

Handles a failure of this Future by returning the result of another Future. If the mapper fails, then the returned future will be failed with this failure.

Refines BaseBridgeEvent.recover ultimately refines Future.recover
resultshared actual default Boolean result()

The result of the operation. This will be null if the operation failed.

Refines BaseBridgeEvent.result ultimately refines Future.result
setHandlershared actual default Future<Boolean> setHandler(Anything(Throwable|Boolean) arg0)

Set a handler for the result.

If the future has already been completed it will be called immediately. Otherwise it will be called when the future is completed.

Refines BaseBridgeEvent.setHandler ultimately refines Future.setHandler
setRawMessageshared actual default BridgeEvent setRawMessage(Object message)

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.

Parameters:
  • message

    the raw message

Refines BaseBridgeEvent.setRawMessage
socketshared default SockJSSocket socket()

Get the SockJSSocket instance corresponding to the event

tryCompleteshared actual default Boolean tryComplete(Boolean arg0)
Inherited Methods
Methods inherited from: BaseBridgeEvent
complete, completer, compose, getRawMessage, map, otherwise, otherwiseEmpty, recover, result, setHandler, setRawMessage, tryComplete, type
Methods inherited from: Future<T>
cause, complete, completer, compose, fail, failed, isComplete, map, mapEmpty, otherwise, otherwiseEmpty, recover, result, setHandler, succeeded, tryComplete, tryFail
Methods inherited from: Object
equals