vertx-lang-scala-docs_2.12 3.4.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package web
  Definition Classes
    ext
-  package handler
  Definition Classes
    web
-  package sockjs
  Definition Classes
    handler
- BridgeEvent
- BridgeOptions
- PermittedOptions
- SockJSHandler
- SockJSHandlerOptions
- SockJSSocket

c

io.vertx.scala.ext.web.handler.sockjs

# BridgeEvent 

###
Companion object BridgeEvent

#### class BridgeEvent extends Future[Boolean]

Represents an event that occurs on the event bus bridge.

Please consult the documentation for a full explanation.

Linear Supertypes
Future[Boolean], AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. BridgeEvent
2. Future
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new BridgeEvent(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: AnyRef
   Definition Classes
     Future
6.  def cause(): Throwable

   A Throwable describing failure.

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

   returns

     the cause or null if the operation succeeded.

   Definition Classes
     Future
7.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
8.  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.

   Definition Classes
     BridgeEvent → Future
9.  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
10.  def completer(): Handler[AsyncResult[Boolean]]

    returns

      an handler completing this future

    Definition Classes
      BridgeEvent → Future
11.  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, 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.

    mapper

      the mapper function

    returns

      the composed future

    Definition Classes
      BridgeEvent → Future
12.  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, 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.

    handler

      the handler

    next

      the next future

    returns

      the next future, used for chaining

    Definition Classes
      BridgeEvent → Future
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
15.  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.

    failureMessage

      the failure message

    Definition Classes
      Future
16.  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.

    cause

      the failure cause

    Definition Classes
      Future
17.  def failed(): Boolean

    Did it fail?

    Did it fail?

    returns

      true if it failed or false otherwise

    Definition Classes
      Future
18.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
19.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
20.  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.web.handler.sockjs.BridgeEvent#setRawMessage should be called with the new message.

    returns

      the raw JSON message for the event

21.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
22.  def isComplete(): Boolean

    Has the future completed?

    Has the future completed?

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

    returns

      true if completed, false if not

    Definition Classes
      Future
23.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
24.  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.

    mapper

      the mapper function

    returns

      the mapped future

    Definition Classes
      BridgeEvent → Future
25.  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.

    value

      the value that eventually completes the mapped future

    returns

      the mapped future

    Definition Classes
      Future
26.  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)` 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.

    returns

      the mapped future

    Definition Classes
      Future
27.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
28.  final def notify(): Unit
    Definition Classes
      AnyRef
29.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
30.  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.

    value

      the value that eventually completes the mapped future

    returns

      the mapped future

    Definition Classes
      BridgeEvent → Future
31.  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.

    mapper

      the mapper function

    returns

      the mapped future

    Definition Classes
      BridgeEvent → Future
32.  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.

    returns

      the mapped future

    Definition Classes
      BridgeEvent → Future
33.  def rawMessage(): JsonObject

    Use io.vertx.scala.ext.web.handler.sockjs.BridgeEvent#getRawMessage instead, will be removed in 3.3

34.  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.

    mapper

      A function which takes the exception of a failure and returns a new future.

    returns

      A recovered future

    Definition Classes
      BridgeEvent → Future
35.  def result(): Boolean

    The result of the operation.

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

    returns

      the result or null if the operation failed.

    Definition Classes
      BridgeEvent → Future
36.  def setFuture(): Future[Boolean]
37.  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.

    returns

      a reference to this, so it can be used fluently

    Definition Classes
      BridgeEvent → Future
38.  def setRawMessage(message: JsonObject): BridgeEvent

    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.

    message

      the raw message

    returns

      this reference, so it can be used fluently

39.  def socket(): SockJSSocket

    Get the SockJSSocket instance corresponding to the event

    Get the SockJSSocket instance corresponding to the event

    returns

      the SockJSSocket instance

40.  def succeeded(): Boolean

    Did it succeed?

    Did it succeed?

    returns

      true if it succeded or false otherwise

    Definition Classes
      Future
41.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
42.  def toString(): String
    Definition Classes
      AnyRef → Any
43.  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.

    returns

      false when the future is already completed

    Definition Classes
      BridgeEvent → Future
44.  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.

    returns

      false when the future is already completed

    Definition Classes
      Future
45.  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.

    failureMessage

      the failure message

    returns

      false when the future is already completed

    Definition Classes
      Future
46.  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.

    cause

      the failure cause

    returns

      false when the future is already completed

    Definition Classes
      Future
47.  def type(): BridgeEventType

    returns

      the type of the event

48.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
49.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
50.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from Future[Boolean]

### Inherited from AnyRef

### Inherited from Any

### Ungrouped