class BaseBridgeEvent extends Future[Boolean]
Represents an event that occurs on the event bus bridge.
Please consult the documentation for a full explanation.
- Alphabetic
- By Inheritance
- BaseBridgeEvent
- Future
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new BaseBridgeEvent(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: AnyRef
- Definition Classes
- Future
-
def
cause(): Throwable
A Throwable describing failure.
A Throwable describing failure. This will be null if the operation succeeded. * @return the cause or null if the operation succeeded.
- Definition Classes
- Future
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
complete(arg0: Boolean): Unit
Set the result.
Set the result. Any handler will be called, if there is one, and the future will be marked as completed. * @param result the result
- Definition Classes
- BaseBridgeEvent → Future
-
def
complete(): Unit
Set a null result.
Set a null result. Any handler will be called, if there is one, and the future will be marked as completed.
- Definition Classes
- Future
-
def
completer(): Handler[AsyncResult[Boolean]]
- returns
an handler completing this future
- Definition Classes
- BaseBridgeEvent → Future
-
def
compose[U](mapper: (Boolean) ⇒ Future[U])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[U]): Future[U]
Compose this future with a
mapper
function.Compose this future with a
mapper
function.When this future (the one on which
compose
is called) succeeds, themapper
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. * @param mapper the mapper function- returns
the composed future
- Definition Classes
- BaseBridgeEvent → Future
-
def
compose[U](handler: Handler[Boolean], next: Future[U])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[U]): Future[U]
Compose this future with a provided
next
future.Compose this future with a provided
next
future.When this (the one on which
compose
is called) future succeeds, thehandler
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 thehandler
will not be called. * @param handler the handler- next
the next future
- returns
the next future, used for chaining
- Definition Classes
- BaseBridgeEvent → Future
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
fail(failureMessage: String): Unit
Try to set the failure.
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. * @param failureMessage the failure message
- Definition Classes
- Future
-
def
fail(cause: Throwable): Unit
Set the failure.
Set the failure. Any handler will be called, if there is one, and the future will be marked as completed. * @param cause the failure cause
- Definition Classes
- Future
-
def
failed(): Boolean
Did it fail? * @return true if it failed or false otherwise
Did it fail? * @return true if it failed or false otherwise
- Definition Classes
- Future
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getRawMessage(): JsonObject
Get the raw JSON message for the event.
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.scala.ext.bridge.BaseBridgeEvent#setRawMessage should be called with the new message. * @return the raw JSON message for the event
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
isComplete(): Boolean
Has the future completed?
Has the future completed?
It's completed if it's either succeeded or failed. * @return true if completed, false if not
- Definition Classes
- Future
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
map[U](mapper: (Boolean) ⇒ U)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[U]): Future[U]
Apply a
mapper
function on this future.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. * @param mapper the mapper function- returns
the mapped future
- Definition Classes
- BaseBridgeEvent → Future
-
def
map[V](value: V)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[V]): Future[V]
Map the result of a future to a specific
value
.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. * @param value the value that eventually completes the mapped future
- returns
the mapped future
- Definition Classes
- Future
-
def
mapEmpty[V]()(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[V]): Future[V]
Map the result of a future to
null
.Map the result of a future to
null
.This is a conveniency for
future.map((T) null)
orfuture.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. * @return the mapped future
- Definition Classes
- Future
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
otherwise(value: Boolean): Future[Boolean]
Map the failure of a future to a specific
value
.Map the failure of a future to a specific
value
.When this future fails, this
value
will complete the future returned by this method call.When this future succeeds, the result will be propagated to the returned future. * @param value the value that eventually completes the mapped future
- returns
the mapped future
- Definition Classes
- BaseBridgeEvent → Future
-
def
otherwise(mapper: (Throwable) ⇒ Boolean): Future[Boolean]
Apply a
mapper
function on this future.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. * @param mapper the mapper function- returns
the mapped future
- Definition Classes
- BaseBridgeEvent → Future
-
def
otherwiseEmpty(): Future[Boolean]
Map the failure of a future to
null
.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. * @return the mapped future
- Definition Classes
- BaseBridgeEvent → Future
-
def
recover(mapper: (Throwable) ⇒ Future[Boolean]): Future[Boolean]
Handles a failure of this Future by returning the result of another Future.
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. * @param mapper A function which takes the exception of a failure and returns a new future.
- returns
A recovered future
- Definition Classes
- BaseBridgeEvent → Future
-
def
result(): Boolean
The result of the operation.
The result of the operation. This will be null if the operation failed. * @return the result or null if the operation failed.
- Definition Classes
- BaseBridgeEvent → Future
- def setFuture(): Future[Boolean]
-
def
setHandler(arg0: Handler[AsyncResult[Boolean]]): Future[Boolean]
Set a handler for the result.
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. * @param handler the Handler that will be called with the result
- returns
a reference to this, so it can be used fluently
- Definition Classes
- BaseBridgeEvent → Future
-
def
setRawMessage(message: JsonObject): BaseBridgeEvent
Get the raw JSON message for the event.
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. * @param message the raw message
- returns
this reference, so it can be used fluently
-
def
succeeded(): Boolean
Did it succeed? * @return true if it succeded or false otherwise
Did it succeed? * @return true if it succeded or false otherwise
- Definition Classes
- Future
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
tryComplete(arg0: Boolean): Boolean
Set the failure.
Set the failure. Any handler will be called, if there is one, and the future will be marked as completed. * @param result the result
- returns
false when the future is already completed
- Definition Classes
- BaseBridgeEvent → Future
-
def
tryComplete(): Boolean
Try to set the result.
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. * @return false when the future is already completed
- Definition Classes
- Future
-
def
tryFail(failureMessage: String): Boolean
Try to set the failure.
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. * @param failureMessage the failure message
- returns
false when the future is already completed
- Definition Classes
- Future
-
def
tryFail(cause: Throwable): Boolean
Try to set the failure.
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. * @param cause the failure cause
- returns
false when the future is already completed
- Definition Classes
- Future
-
def
type(): BridgeEventType
- returns
the type of the event
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )