vertx-lang-scala-docs_2.12 3.9.1 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
- Cookie
- GoAway
- Http2Settings
- HttpClient
- HttpClientOptions
- HttpClientRequest
- HttpClientResponse
- HttpConnection
- HttpFrame
- HttpServer
- HttpServerFileUpload
- HttpServerOptions
- HttpServerRequest
- HttpServerResponse
- RequestOptions
- ServerWebSocket
- StreamPriority
- WebSocket
- WebSocketBase
- WebSocketConnectOptions
- 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.Pipe to pipe 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. * @return 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). * @param handler the handler

   returns

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

4.  abstract def close(statusCode: Short, reason: Option[String], handler: Handler[AsyncResult[Unit]]): Unit

   Same as but with an `handler` called when the operation completes

5.  abstract def close(statusCode: Short, reason: Option[String]): Unit

   Close sending a close frame with specified status code and reason.

   Close sending a close frame with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1

   No more messages can be sent. * @param statusCode Status code

   reason

     reason of closure

6.  abstract def close(statusCode: Short, handler: Handler[AsyncResult[Unit]]): Unit

   Same as io.vertx.scala.core.http.WebSocketBase#close but with an `handler` called when the operation completes

7.  abstract def close(statusCode: Short): Unit

   Close the WebSocket sending a close frame with specified status code.

   Close the WebSocket sending a close frame with specified status code. You can give a look at various close payloads here: RFC6455 section 7.4.1

   No more messages can be sent. * @param statusCode Status code

8.  abstract def close(handler: Handler[AsyncResult[Unit]]): Unit

   Same as io.vertx.scala.core.http.WebSocketBase#close but with an `handler` called when the operation completes

9.  abstract def close(): Unit

   Close the WebSocket sending the default close frame.

   Close the WebSocket sending the default close frame.

   No more messages can be sent.

10.  abstract def closeFuture(statusCode: Short, reason: Option[String]): scala.concurrent.Future[Unit]

    Like close but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

11.  abstract def closeFuture(statusCode: Short): scala.concurrent.Future[Unit]

    Like close but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

12.  abstract def closeFuture(): scala.concurrent.Future[Unit]

    Like close but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

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

    Set a close handler.

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

    After this callback, no more messages are expected. When the WebSocket received a close frame, the io.vertx.scala.core.http.WebSocketBase#closeStatusCode will return the status code and io.vertx.scala.core.http.WebSocketBase#closeReason will return the reason. * @param handler the handler

    returns

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

14.  abstract def closeReason(): String

    Returns the reason message received when the WebSocket was closed by the other side, otherwise `null`.

15.  abstract def closeStatusCode(): Short

    Returns the status code received when the WebSocket was closed by the other side, otherwise `null`.

16.  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`. * @param handler the handler

    returns

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

    Definition Classes
      WebSocketBase → WriteStream
17.  abstract def end(handler: Handler[AsyncResult[Unit]]): Unit

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

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

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

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

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

    Definition Classes
      WebSocketBase → WriteStream
19.  abstract def end(data: Buffer, handler: Handler[AsyncResult[Unit]]): Unit

    Same as but with an `handler` called when the operation completes

    Same as but with an `handler` called when the operation completes

    Definition Classes
      WebSocketBase → WriteStream
20.  abstract def end(data: 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. * @param data the data to write

    Definition Classes
      WebSocketBase → WriteStream
21.  abstract def endFuture(): scala.concurrent.Future[Unit]

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      WebSocketBase → WriteStream
22.  abstract def endFuture(data: Buffer): scala.concurrent.Future[Unit]

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      WebSocketBase → WriteStream
23.  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. * @return a reference to this, so the API can be used fluently

    Definition Classes
      WebSocketBase → ReadStream
24.  abstract def exceptionHandler(handler: Handler[Throwable]): WebSocketBase

    Set an exception handler on the write stream.

    Set an exception handler on the write stream. * @param handler the exception handler

    returns

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

    Definition Classes
      WebSocketBase → WriteStream → ReadStream → StreamBase
25.  abstract def fetch(amount: Long): WebSocketBase

    Fetch the specified `amount` of elements.

    Fetch the specified `amount` of elements. If the `ReadStream` has been paused, reading will recommence with the specified `amount` of items, otherwise the specified `amount` will be added to the current stream demand. * @return a reference to this, so the API can be used fluently

    Definition Classes
      WebSocketBase → ReadStream
26.  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. * @param handler the handler

    returns

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

27.  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. * @return a reference to this, so the API can be used fluently

    Definition Classes
      WebSocketBase → ReadStream
28.  abstract def headers(): MultiMap

    Returns the HTTP headers when the WebSocket is first obtained in the handler.

    Returns the HTTP headers when the WebSocket is first obtained in the handler.

    The headers will be `null` on subsequent interactions. * @return the headers

29.  abstract def isClosed(): Boolean

    returns

      `true` if the WebSocket is closed

30.  abstract def isSsl(): Boolean

    returns

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

31.  abstract def localAddress(): SocketAddress

    returns

      the local address for this connection, possibly `null` (e.g a server bound on a domain socket)

32.  abstract def pause(): WebSocketBase

    Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.

    Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.

    While it's paused, no data will be sent to the data `handler`. * @return a reference to this, so the API can be used fluently

    Definition Classes
      WebSocketBase → ReadStream
33.  abstract def pipe(): Pipe[Buffer]

    Pause this stream and return a to transfer the elements of this stream to a destination .

    Pause this stream and return a to transfer the elements of this stream to a destination .

    The stream will be resumed when the pipe will be wired to a `WriteStream`. * @return a pipe

    Definition Classes
      WebSocketBase → ReadStream
34.  abstract def pipeTo(dst: WriteStream[Buffer], handler: Handler[AsyncResult[Unit]]): Unit

    Pipe this `ReadStream` to the `WriteStream`.

    Pipe this `ReadStream` to the `WriteStream`.

    Elements emitted by this stream will be written to the write stream until this stream ends or fails.

    Once this stream has ended or failed, the write stream will be ended and the `handler` will be called with the result. * @param dst the destination write stream

    Definition Classes
      WebSocketBase → ReadStream
35.  abstract def pipeTo(dst: WriteStream[Buffer]): Unit

    Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

    Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

    Definition Classes
      WebSocketBase → ReadStream
36.  abstract def pipeToFuture(dst: WriteStream[Buffer]): scala.concurrent.Future[Unit]

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      WebSocketBase → ReadStream
37.  abstract def pongHandler(handler: Handler[Buffer]): WebSocketBase

    Set a pong frame handler on the connection.

    Set a pong frame handler on the connection. This handler will be invoked every time a pong frame is received on the server, and can be used by both clients and servers since the RFC 6455 section 5.5.2 and section 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 ping frames should immediately be responded to with a pong frame with identical content

    Pong frames may be received unsolicited. * @param handler the handler

    returns

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

38.  abstract def remoteAddress(): SocketAddress

    returns

      the remote address for this connection, possibly `null` (e.g a server bound on a domain socket)

39.  abstract def resume(): WebSocketBase

    Resume reading, and sets the buffer in `flowing` mode.

    Resume reading, and sets the buffer in `flowing` mode.

    If the `ReadStream` has been paused, reading will recommence on it. * @return a reference to this, so the API can be used fluently

    Definition Classes
      WebSocketBase → ReadStream
40.  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... * @param maxSize the max size of the write stream

    returns

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

    Definition Classes
      WebSocketBase → WriteStream
41.  abstract 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.

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

43.  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 * @param handler the handler

    returns

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

44.  abstract def write(data: Buffer, handler: Handler[AsyncResult[Unit]]): WebSocketBase

    Same as but with an `handler` called when the operation completes

    Same as but with an `handler` called when the operation completes

    Definition Classes
      WebSocketBase → WriteStream
45.  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. * @param data the data to write

    returns

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

    Definition Classes
      WebSocketBase → WriteStream
46.  abstract def writeBinaryMessage(data: Buffer, handler: Handler[AsyncResult[Unit]]): WebSocketBase

    Same as io.vertx.scala.core.http.WebSocketBase#writeBinaryMessage but with an `handler` called when the operation completes

47.  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. * @param data the data to write

    returns

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

48.  abstract def writeBinaryMessageFuture(data: Buffer): scala.concurrent.Future[Unit]

    Like writeBinaryMessage but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

49.  abstract def writeFinalBinaryFrame(data: Buffer, handler: Handler[AsyncResult[Unit]]): WebSocketBase

    Same as io.vertx.scala.core.http.WebSocketBase#writeFinalBinaryFrame but with an `handler` called when the operation completes

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

    Write a final WebSocket binary frame to the connection * @param data The data to write

    Write a final WebSocket binary frame to the connection * @param data The data to write

    returns

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

51.  abstract def writeFinalBinaryFrameFuture(data: Buffer): scala.concurrent.Future[Unit]

    Like writeFinalBinaryFrame but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

52.  abstract def writeFinalTextFrame(text: String, handler: Handler[AsyncResult[Unit]]): WebSocketBase

    Same as io.vertx.scala.core.http.WebSocketBase#writeFinalTextFrame but with an `handler` called when the operation completes

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

    Write a final WebSocket text frame to the connection * @param text The text to write

    Write a final WebSocket text frame to the connection * @param text The text to write

    returns

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

54.  abstract def writeFinalTextFrameFuture(text: String): scala.concurrent.Future[Unit]

    Like writeFinalTextFrame but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

55.  abstract def writeFrame(frame: WebSocketFrame, handler: Handler[AsyncResult[Unit]]): WebSocketBase

    Same as io.vertx.scala.core.http.WebSocketBase#writeFrame but with an `handler` called when the operation completes

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

    Write a WebSocket frame to the connection * @param frame the frame to write

    Write a WebSocket frame to the connection * @param frame the frame to write

    returns

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

57.  abstract def writeFrameFuture(frame: WebSocketFrame): scala.concurrent.Future[Unit]

    Like writeFrame but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

58.  abstract def writeFuture(data: Buffer): scala.concurrent.Future[Unit]

    Like write but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like write but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      WebSocketBase → WriteStream
59.  abstract def writePing(data: Buffer): WebSocketBase

    Writes a ping frame to the connection.

    Writes a ping frame 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 section 5.5.2.

    There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents. * @param data the data to write, may be at most 125 bytes

    returns

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

60.  abstract def writePong(data: Buffer): WebSocketBase

    Writes a pong frame to the connection.

    Writes a pong frame 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 frame, as the server and client both handle responding to a ping from with a pong from 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. * @param data the data to write, may be at most 125 bytes

    returns

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

61.  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 * @return true if write queue is full

    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 * @return true if write queue is full

    Definition Classes
      WebSocketBase → WriteStream
62.  abstract def writeTextMessage(text: String, handler: Handler[AsyncResult[Unit]]): WebSocketBase

    Same as io.vertx.scala.core.http.WebSocketBase#writeTextMessage but with an `handler` called when the operation completes

63.  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. * @param text the data to write

    returns

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

64.  abstract def writeTextMessageFuture(text: String): scala.concurrent.Future[Unit]

    Like writeTextMessage but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

### 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
     @native() @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
   Annotations
     @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
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
    Annotations
      @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
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
      @native() @throws( ... )

### Inherited from WriteStream[Buffer]

### Inherited from ReadStream[Buffer]

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped