org.vertx.scala.core.http

ServerWebSocket

final class ServerWebSocket extends Self with WebSocketBase

Represents a server side WebSocket that is passed into a the websocketHandler of an org.vertx.scala.core.http.HttpServer

Instances of this class are not thread-safe

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ServerWebSocket
  2. WebSocketBase
  3. WriteStream
  4. ReadStream
  5. ReadSupport
  6. ExceptionSupport
  7. AsJava
  8. Self
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type J = java.core.http.ServerWebSocket

    The internal type of the Java wrapped class.

    The internal type of the Java wrapped class.

    Definition Classes
    ServerWebSocketWebSocketBaseWriteStreamReadStreamReadSupportExceptionSupport → AsJava

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val asJava: java.core.http.ServerWebSocket

    The internal instance of the Java wrapped class.

    The internal instance of the Java wrapped class.

    Definition Classes
    ServerWebSocket → AsJava
  8. def binaryHandlerID(): String

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

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

    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.

    Definition Classes
    WebSocketBase
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def close(): Unit

    Close the websocket

    Close the websocket

    Definition Classes
    WebSocketBase
  11. def closeHandler(handler: ⇒ Unit): ServerWebSocket.this.type

    Set a closed handler on the connection

    Set a closed handler on the connection

    Definition Classes
    WebSocketBase
  12. def dataHandler(handler: (Buffer) ⇒ Unit): ServerWebSocket.this.type

    Set a data handler.

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

    Definition Classes
    ReadStreamReadSupport
  13. def drainHandler(handler: ⇒ Unit): ServerWebSocket.this.type

    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 has been reduced to maxSize / 2. See org.vertx.scala.core.streams.Pump for an example of this being used.

    Definition Classes
    WriteStream
  14. def endHandler(handler: ⇒ Unit): ServerWebSocket.this.type

    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.

    Definition Classes
    ReadStream
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  17. def exceptionHandler(handler: (Throwable) ⇒ Unit): ServerWebSocket.this.type

    Set an exception handler.

    Set an exception handler.

    Definition Classes
    ExceptionSupport
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. def headers(): MultiMap

    A map of all headers in the request to upgrade to websocket

  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. def localAddress(): InetSocketAddress

    Return the local address for this socket

    Return the local address for this socket

    Definition Classes
    WebSocketBase
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. def path(): String

    The path the websocket is attempting to connect at

  28. def pause(): ServerWebSocket.this.type

    Pause the ReadSupport.

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

    Definition Classes
    ReadSupport
  29. def query(): String

    The query string passed on the websocket uri

  30. def reject(): ServerWebSocket

    Reject the WebSocket

    Reject the WebSocket

    Calling this method from the websocketHandler gives you the opportunity to reject the websocket, which will cause the websocket handshake to fail by returning a 404 response code.

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

  31. def remoteAddress(): InetSocketAddress

    Return the remote address for this socket

    Return the remote address for this socket

    Definition Classes
    WebSocketBase
  32. def resume(): ServerWebSocket.this.type

    Resume reading.

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

    Definition Classes
    ReadSupport
  33. def setWriteQueueMaxSize(maxSize: Int): ServerWebSocket.this.type

    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 bytes in the write queue. This is used as an indicator by classes such as Pump to provide flow control.

    Definition Classes
    WriteStream
  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  35. 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
    WebSocketBase
  36. def toString(): String

    Definition Classes
    AnyRef → Any
  37. def uri(): String

    The uri the websocket handshake occurred at

  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def wrap[X](doStuff: ⇒ X): ServerWebSocket.this.type

    Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types

    Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types

    Attributes
    protected[this]
    Definition Classes
    Self
  42. def write(data: Buffer): ServerWebSocket.this.type

    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 org.vertx.scala.core.streams.WriteStream.writeQueueFull() method before writing. This is done automatically if using a org.vertx.scala.core.streams.Pump.

    Definition Classes
    WriteStream
  43. def writeBinaryFrame(data: Buffer): ServerWebSocket.this.type

    Write data to the websocket as a binary frame

    Write data to the websocket as a binary frame

    Definition Classes
    WebSocketBase
  44. def writeQueueFull(): Boolean

    This will return true if there are more bytes in the write queue than the value set using org.vertx.scala.core.streams.WriteStream.setWriteQueueMaxSize()

    This will return true if there are more bytes in the write queue than the value set using org.vertx.scala.core.streams.WriteStream.setWriteQueueMaxSize()

    Definition Classes
    WriteStream
  45. def writeTextFrame(str: String): ServerWebSocket.this.type

    Write str to the websocket as a text frame

    Write str to the websocket as a text frame

    Definition Classes
    WebSocketBase

Inherited from WebSocketBase

Inherited from WriteStream

Inherited from ReadStream

Inherited from ReadSupport[Buffer]

Inherited from ExceptionSupport

Inherited from AsJava

Inherited from Self

Inherited from AnyRef

Inherited from Any

Ungrouped