vertx-lang-scala-docs_2.12 3.5.2.CR2 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

c

io.vertx.scala.core.http

# WebSocket 

###
Companion object WebSocket

#### class WebSocket extends WebSocketBase

Represents a client-side WebSocket.

Linear Supertypes
WebSocketBase, WriteStream[Buffer], ReadStream[Buffer], StreamBase, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

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

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new WebSocket(_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
     WebSocket → WebSocketBase → WriteStream → ReadStream → StreamBase
6.  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

   Definition Classes
     WebSocket → WebSocketBase
7.  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.WebSocket#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

   Definition Classes
     WebSocket → WebSocketBase
8.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
9.  def close(statusCode: Short, reason: Option[String]): Unit
   Definition Classes
     WebSocket → WebSocketBase
10.  def close(statusCode: Short): Unit
    Definition Classes
      WebSocket → WebSocketBase
11.  def close(): Unit

    Close the WebSocket.

    Close the WebSocket.

    Definition Classes
      WebSocket → WebSocketBase
12.  def closeHandler(handler: Handler[Unit]): WebSocket

    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

    Definition Classes
      WebSocket → WebSocketBase
13.  def drainHandler(handler: Handler[Unit]): WebSocket

    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
      WebSocket → WebSocketBase → WriteStream
14.  def end(): Unit

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

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

    Definition Classes
      WebSocket → WebSocketBase → WriteStream
15.  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
      WebSocket → WebSocketBase → WriteStream
16.  def endHandler(endHandler: Handler[Unit]): WebSocket

    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
      WebSocket → WebSocketBase → ReadStream
17.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
18.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
19.  def exceptionHandler(handler: Handler[Throwable]): WebSocket

    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
      WebSocket → WebSocketBase → WriteStream → ReadStream → StreamBase
20.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
21.  def frameHandler(handler: Handler[WebSocketFrame]): WebSocket

    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

    Definition Classes
      WebSocket → WebSocketBase
22.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
23.  def handler(handler: Handler[Buffer]): WebSocket

    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
      WebSocket → WebSocketBase → ReadStream
24.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
25.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
26.  def isSsl(): Boolean

    returns

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

    Definition Classes
      WebSocket → WebSocketBase
27.  def localAddress(): SocketAddress

    returns

      the local address for this socket

    Definition Classes
      WebSocket → WebSocketBase
28.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
29.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
30.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
31.  def pause(): WebSocket

    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
      WebSocket → WebSocketBase → ReadStream
32.  def pongHandler(handler: Handler[Buffer]): WebSocketBase

    Set a pong message handler on the connection.

    Set a pong message handler on the connection. This handler will be invoked every time a pong message is received on the server, and can be used by both clients and servers since the RFC 6455 Sections 5.5.2 and 5.5.3 do not specify whether the client or server sends a ping.

    Pong frames may be at most 125 bytes (octets).

    There is no ping handler since pings should immediately be responded to with a pong with identical content

    Pong frames may be received unsolicited.

    handler

      the handler

    returns

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

    Definition Classes
      WebSocket → WebSocketBase
33.  def remoteAddress(): SocketAddress

    returns

      the remote address for this socket

    Definition Classes
      WebSocket → WebSocketBase
34.  def resume(): WebSocket

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

    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
      WebSocket → WebSocketBase → WriteStream
36.  def subProtocol(): String

    Returns the websocket sub protocol selected by the websocket handshake.

    Returns the websocket sub protocol selected by the websocket handshake.

    On the server, the value will be `null` when the handler receives the websocket callback as the handshake will not be completed yet.

    Definition Classes
      WebSocket → WebSocketBase
37.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
38.  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.

    Definition Classes
      WebSocket → WebSocketBase
39.  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

    Definition Classes
      WebSocket → WebSocketBase
40.  def toString(): String
    Definition Classes
      AnyRef → Any
41.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
42.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
43.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
44.  def write(data: Buffer): WebSocket

    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
      WebSocket → WebSocketBase → WriteStream
45.  def writeBinaryMessage(data: Buffer): WebSocket

    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

    Definition Classes
      WebSocket → WebSocketBase
46.  def writeFinalBinaryFrame(data: Buffer): WebSocket

    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

    Definition Classes
      WebSocket → WebSocketBase
47.  def writeFinalTextFrame(text: String): WebSocket

    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

    Definition Classes
      WebSocket → WebSocketBase
48.  def writeFrame(frame: WebSocketFrame): WebSocket

    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

    Definition Classes
      WebSocket → WebSocketBase
49.  def writePing(data: Buffer): WebSocketBase

    Writes a ping to the connection.

    Writes a ping to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

    This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2.

    There is no pingHandler because RFC 6455 section 5.5.2 clearly states that the only response to a ping is a pong with identical contents.

    data

      the data to write, may be at most 125 bytes

    returns

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

    Definition Classes
      WebSocket → WebSocketBase
50.  def writePong(data: Buffer): WebSocketBase

    Writes a pong to the connection.

    Writes a pong to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

    This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2.

    There is no need to manually write a Pong, as the server and client both handle responding to a ping with a pong automatically and this is exposed to users.RFC 6455 Section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.

    data

      the data to write, may be at most 125 bytes

    returns

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

    Definition Classes
      WebSocket → WebSocketBase
51.  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.WebSocket#setWriteQueueMaxSize

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

    returns

      true if write queue is full

    Definition Classes
      WebSocket → WebSocketBase → WriteStream
52.  def writeTextMessage(text: String): WebSocket

    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

    Definition Classes
      WebSocket → WebSocketBase

### Inherited from WebSocketBase

### Inherited from WriteStream[Buffer]

### Inherited from ReadStream[Buffer]

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped