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

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package http
  Definition Classes
    core
- GoAway
- Http2Settings
- HttpClient
- HttpClientOptions
- HttpClientRequest
- HttpClientResponse
- HttpConnection
- HttpFrame
- HttpServer
- HttpServerFileUpload
- HttpServerOptions
- HttpServerRequest
- HttpServerResponse
- RequestOptions
- ServerWebSocket
- WebSocket
- WebSocketBase
- WebSocketFrame

t

io.vertx.scala.core.http

# WebSocketBase 

###
Companion object WebSocketBase

#### trait WebSocketBase extends ReadStream[Buffer] with WriteStream[Buffer]

Base WebSocket implementation.

It implements both and so it can be used with io.vertx.scala.core.streams.Pump to pump data with flow control.

Linear Supertypes
WriteStream[Buffer], ReadStream[Buffer], StreamBase, AnyRef, Any
Known Subclasses
ServerWebSocket, WebSocket
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. WebSocketBase
2. WriteStream
3. ReadStream
4. StreamBase
5. AnyRef
6. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1.  abstract def asJava: AnyRef
   Definition Classes
     WebSocketBase → WriteStream → ReadStream → StreamBase
2.  abstract def binaryHandlerID(): String

   When a `Websocket` is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.

   When a `Websocket` is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.

   Given this ID, a different event loop can send a binary frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

   returns

     the binary handler id

3.  abstract def binaryMessageHandler(handler: Handler[Buffer]): WebSocketBase

   Set a binary message handler on the connection.

   Set a binary message handler on the connection. This handler serves a similar purpose to io.vertx.scala.core.http.WebSocketBase#handler except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated into a single buffer before calling the handler (using io.vertx.scala.core.http.WebSocketFrame#isFinal to find the boundaries).

   handler

     the handler

   returns

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

4.  abstract def close(): Unit

   Close the WebSocket.

5.  abstract def closeHandler(handler: Handler[Unit]): WebSocketBase

   Set a close handler.

   Set a close handler. This will be called when the WebSocket is closed.

   handler

     the handler

   returns

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

6.  abstract def drainHandler(handler: Handler[Unit]): WebSocketBase

   Set a drain handler on the stream.

   Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See io.vertx.scala.core.streams.Pump for an example of this being used.

   The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to `maxSize / 2`.

   handler

     the handler

   returns

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

   Definition Classes
     WebSocketBase → WriteStream
7.  abstract def end(): Unit

   Calls io.vertx.scala.core.http.WebSocketBase#close

   Calls io.vertx.scala.core.http.WebSocketBase#close

   Definition Classes
     WebSocketBase → WriteStream
8.  abstract def end(t: Buffer): Unit

   Same as io.vertx.scala.core.http.WebSocketBase#end but writes some data to the stream before ending.

   Same as io.vertx.scala.core.http.WebSocketBase#end but writes some data to the stream before ending.

   Definition Classes
     WebSocketBase → WriteStream
9.  abstract def endHandler(endHandler: Handler[Unit]): WebSocketBase

   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
     WebSocketBase → ReadStream
10.  abstract def exceptionHandler(handler: Handler[Throwable]): WebSocketBase

    Set an exception handler on the write stream.

    Set an exception handler on the write stream.

    handler

      the exception handler

    returns

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

    Definition Classes
      WebSocketBase → WriteStream → ReadStream → StreamBase
11.  abstract def frameHandler(handler: Handler[WebSocketFrame]): WebSocketBase

    Set a frame handler on the connection.

    Set a frame handler on the connection. This handler will be called when frames are read on the connection.

    handler

      the handler

    returns

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

12.  abstract def handler(handler: Handler[Buffer]): WebSocketBase

    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
      WebSocketBase → ReadStream
13.  abstract def isSsl(): Boolean

    returns

      true if this io.vertx.scala.core.http.HttpConnection is encrypted via SSL/TLS.

14.  abstract def localAddress(): SocketAddress

    returns

      the local address for this socket

15.  abstract def pause(): WebSocketBase

    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
      WebSocketBase → ReadStream
16.  abstract def remoteAddress(): SocketAddress

    returns

      the remote address for this socket

17.  abstract def resume(): WebSocketBase

    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
      WebSocketBase → ReadStream
18.  abstract def setWriteQueueMaxSize(maxSize: Int): WebSocketBase

    Set the maximum size of the write queue to `maxSize`.

    Set the maximum size of the write queue to `maxSize`. You will still be able to write to the stream even if there is more than `maxSize` items in the write queue. This is used as an indicator by classes such as `Pump` to provide flow control.

    The value is defined by the implementation of the stream, e.g in bytes for a io.vertx.scala.core.net.NetSocket, the number of io.vertx.scala.core.eventbus.Message for a io.vertx.scala.core.eventbus.MessageProducer, etc...

    maxSize

      the max size of the write stream

    returns

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

    Definition Classes
      WebSocketBase → WriteStream
19.  abstract def textHandlerID(): String

    When a `Websocket` is created it automatically registers an event handler with the eventbus, the ID of that handler is given by `textHandlerID`.

    When a `Websocket` is created it automatically registers an event handler with the eventbus, the ID of that handler is given by `textHandlerID`.

    Given this ID, a different event loop can send a text frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

20.  abstract def textMessageHandler(handler: Handler[String]): WebSocketBase

    Set a text message handler on the connection.

    Set a text message handler on the connection. This handler will be called similar to the , but the buffer will be converted to a String first

    handler

      the handler

    returns

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

21.  abstract def write(data: Buffer): WebSocketBase

    Write some data to the stream.

    Write some data to the stream. The data is put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the io.vertx.scala.core.streams.WriteStream#writeQueueFull method before writing. This is done automatically if using a io.vertx.scala.core.streams.Pump.

    data

      the data to write

    returns

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

    Definition Classes
      WebSocketBase → WriteStream
22.  abstract def writeBinaryMessage(data: Buffer): WebSocketBase

    Writes a (potentially large) piece of binary data to the connection.

    Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

    data

      the data to write

    returns

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

23.  abstract def writeFinalBinaryFrame(data: Buffer): WebSocketBase

    Write a final WebSocket binary frame to the connection

    Write a final WebSocket binary frame to the connection

    data

      The data to write

    returns

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

24.  abstract def writeFinalTextFrame(text: String): WebSocketBase

    Write a final WebSocket text frame to the connection

    Write a final WebSocket text frame to the connection

    text

      The text to write

    returns

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

25.  abstract def writeFrame(frame: WebSocketFrame): WebSocketBase

    Write a WebSocket frame to the connection

    Write a WebSocket frame to the connection

    frame

      the frame to write

    returns

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

26.  abstract def writeQueueFull(): Boolean

    This will return `true` if there are more bytes in the write queue than the value set using io.vertx.scala.core.http.WebSocketBase#setWriteQueueMaxSize

    This will return `true` if there are more bytes in the write queue than the value set using io.vertx.scala.core.http.WebSocketBase#setWriteQueueMaxSize

    returns

      true if write queue is full

    Definition Classes
      WebSocketBase → WriteStream
27.  abstract def writeTextMessage(text: String): WebSocketBase

    Writes a (potentially large) piece of text data to the connection.

    Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

    text

      the data to write

    returns

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

### Concrete 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 clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
9.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
18.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
19.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from WriteStream[Buffer]

### Inherited from ReadStream[Buffer]

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped