class WebSocketStream extends ReadStream[WebSocket]

A stream for io.vertx.scala.core.http.HttpClient WebSocket connection.

When the connection attempt is successful, the stream handler is called back with the io.vertx.scala.core.http.WebSocket argument, immediately followed by a call to the end handler. When the connection attempt fails, the exception handler is invoked.

The connection occurs when the io.vertx.scala.core.http.WebSocketStream#handler method is called with a non null handler, the other handlers should be set before setting the handler.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketStream
  2. ReadStream
  3. StreamBase
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebSocketStream(_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
    WebSocketStreamReadStreamStreamBase
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def endHandler(endHandler: Handler[Unit]): WebSocketStream

    Set an end handler.

    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    WebSocketStreamReadStream
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def exceptionHandler(handler: Handler[Throwable]): WebSocketStream

    Set an exception handler on the read stream.

    Set an exception handler on the read stream.

    handler

    the exception handler

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    WebSocketStreamReadStreamStreamBase
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  13. def handler(handler: Handler[WebSocket]): WebSocketStream

    Set a data handler.

    Set a data handler. As data is read, the handler will be called with the data.

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    WebSocketStreamReadStream
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  19. def pause(): WebSocketStream

    Pause the ReadSupport.

    Pause the ReadSupport. While it's paused, no data will be sent to the dataHandler

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    WebSocketStreamReadStream
  20. def resume(): WebSocketStream

    Resume reading.

    Resume reading. If the ReadSupport has been paused, reading will recommence on it.

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    WebSocketStreamReadStream
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ReadStream[WebSocket]

Inherited from StreamBase

Inherited from AnyRef

Inherited from Any

Ungrouped