class ServerWebSocket extends WebSocketBase

Represents a server side WebSocket.

Instances of this class are passed into a io.vertx.scala.core.http.HttpServer#websocketHandler or provided when a WebSocket handshake is manually io.vertx.scala.core.http.HttpServerRequest#upgradeed.

Linear Supertypes
WebSocketBase, WriteStream[Buffer], ReadStream[Buffer], StreamBase, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerWebSocket
  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 ServerWebSocket(_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. def accept(): Unit

    Accept the WebSocket and terminate the WebSocket handshake.

    Accept the WebSocket and terminate the WebSocket handshake.

    This method should be called from the websocket handler to explicitely accept the websocker and terminate the WebSocket handshake.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asJava: AnyRef
  7. 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
    ServerWebSocketWebSocketBase
  8. 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.ServerWebSocket#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
    ServerWebSocketWebSocketBase
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. def close(statusCode: Short, reason: Option[String]): Unit
    Definition Classes
    ServerWebSocketWebSocketBase
  11. def close(statusCode: Short): Unit
    Definition Classes
    ServerWebSocketWebSocketBase
  12. def close(): Unit

    Close the WebSocket.

    Close the WebSocket.

    Definition Classes
    ServerWebSocketWebSocketBase
  13. def closeHandler(handler: Handler[Unit]): ServerWebSocket

    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
    ServerWebSocketWebSocketBase
  14. def drainHandler(handler: Handler[Unit]): ServerWebSocket

    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
    ServerWebSocketWebSocketBaseWriteStream
  15. def end(): Unit

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

  16. 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
    ServerWebSocketWebSocketBaseWriteStream
  17. def endHandler(endHandler: Handler[Unit]): ServerWebSocket

    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
    ServerWebSocketWebSocketBaseReadStream
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def exceptionHandler(handler: Handler[Throwable]): ServerWebSocket

    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
    ServerWebSocketWebSocketBaseWriteStreamReadStreamStreamBase
  21. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def frameHandler(handler: Handler[WebSocketFrame]): ServerWebSocket

    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
    ServerWebSocketWebSocketBase
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def handler(handler: Handler[Buffer]): ServerWebSocket

    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
    ServerWebSocketWebSocketBaseReadStream
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def headers(): MultiMap

    returns

    the headers in the WebSocket handshake

  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isSsl(): Boolean

    returns

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

    Definition Classes
    ServerWebSocketWebSocketBase
  29. def localAddress(): SocketAddress

    returns

    the local address for this socket

    Definition Classes
    ServerWebSocketWebSocketBase
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. def path(): String

    returns

    the WebSocket handshake path.

  34. def pause(): ServerWebSocket

    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
    ServerWebSocketWebSocketBaseReadStream
  35. 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
    ServerWebSocketWebSocketBase
  36. def query(): Option[String]

    returns

    the WebSocket handshake query string.

  37. def reject(status: Int): Unit

    Like io.vertx.scala.core.http.ServerWebSocket#reject but with a status.

  38. def reject(): Unit

    Reject the WebSocket.

    Reject the WebSocket.

    Calling this method from the websocket handler when it is first passed to you gives you the opportunity to reject the websocket, which will cause the websocket handshake to fail by returning a response code.

    You might use this method, if for example you only want to accept WebSockets with a particular path.

  39. def remoteAddress(): SocketAddress

    returns

    the remote address for this socket

    Definition Classes
    ServerWebSocketWebSocketBase
  40. def resume(): ServerWebSocket

    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
    ServerWebSocketWebSocketBaseReadStream
  41. def setWriteQueueMaxSize(maxSize: Int): ServerWebSocket

    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
    ServerWebSocketWebSocketBaseWriteStream
  42. 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
    ServerWebSocketWebSocketBase
  43. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  44. 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
    ServerWebSocketWebSocketBase
  45. 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
    ServerWebSocketWebSocketBase
  46. def toString(): String
    Definition Classes
    AnyRef → Any
  47. def uri(): String
  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
    @native() @throws( ... )
  51. def write(data: Buffer): ServerWebSocket

    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
    ServerWebSocketWebSocketBaseWriteStream
  52. def writeBinaryMessage(data: Buffer): ServerWebSocket

    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
    ServerWebSocketWebSocketBase
  53. def writeFinalBinaryFrame(data: Buffer): ServerWebSocket

    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
    ServerWebSocketWebSocketBase
  54. def writeFinalTextFrame(text: String): ServerWebSocket

    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
    ServerWebSocketWebSocketBase
  55. def writeFrame(frame: WebSocketFrame): ServerWebSocket

    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
    ServerWebSocketWebSocketBase
  56. 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
    ServerWebSocketWebSocketBase
  57. 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
    ServerWebSocketWebSocketBase
  58. 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.ServerWebSocket#setWriteQueueMaxSize

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

    returns

    true if write queue is full

    Definition Classes
    ServerWebSocketWebSocketBaseWriteStream
  59. 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

    Definition Classes
    ServerWebSocketWebSocketBase

Inherited from WebSocketBase

Inherited from WriteStream[Buffer]

Inherited from ReadStream[Buffer]

Inherited from StreamBase

Inherited from AnyRef

Inherited from Any

Ungrouped