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
    WebSocketWebSocketBaseWriteStreamReadStreamStreamBase
  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. * @return the binary handler id

    Definition Classes
    WebSocketWebSocketBase
  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). * @param handler the handler

    returns

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

    Definition Classes
    WebSocketWebSocketBase
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def close(statusCode: Short, reason: Option[String], 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
    WebSocketWebSocketBase
  10. 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

    Definition Classes
    WebSocketWebSocketBase
  11. 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

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

    Definition Classes
    WebSocketWebSocketBase
  12. 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

    Definition Classes
    WebSocketWebSocketBase
  13. 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

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

    Definition Classes
    WebSocketWebSocketBase
  14. 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.

    Definition Classes
    WebSocketWebSocketBase
  15. def closeFuture(statusCode: Short, reason: Option[String]): scala.concurrent.Future[Unit]

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

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

    Definition Classes
    WebSocketWebSocketBase
  16. def closeFuture(statusCode: Short): scala.concurrent.Future[Unit]

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

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

    Definition Classes
    WebSocketWebSocketBase
  17. def closeFuture(): scala.concurrent.Future[Unit]

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

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

    Definition Classes
    WebSocketWebSocketBase
  18. def closeHandler(handler: Handler[Unit]): WebSocket

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

    returns

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

    Definition Classes
    WebSocketWebSocketBase
  19. 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. * @param handler the handler

    returns

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

    Definition Classes
    WebSocketWebSocketBaseWriteStream
  20. def end(handler: Handler[AsyncResult[Unit]]): Unit

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

  21. def end(): Unit

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

  22. 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
    WebSocketWebSocketBaseWriteStream
  23. 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
    WebSocketWebSocketBaseWriteStream
  24. 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
    WebSocketWebSocketBaseWriteStream
  25. 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
    WebSocketWebSocketBaseWriteStream
  26. 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. * @return a reference to this, so the API can be used fluently

    Definition Classes
    WebSocketWebSocketBaseReadStream
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def exceptionHandler(handler: Handler[Throwable]): WebSocket

    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
    WebSocketWebSocketBaseWriteStreamReadStreamStreamBase
  30. def fetch(amount: Long): WebSocket

    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
    WebSocketWebSocketBaseReadStream
  31. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. 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. * @param handler the handler

    returns

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

    Definition Classes
    WebSocketWebSocketBase
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. 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. * @return a reference to this, so the API can be used fluently

    Definition Classes
    WebSocketWebSocketBaseReadStream
  35. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def isClosed(): Boolean

    returns

    true if the WebSocket is closed

    Definition Classes
    WebSocketWebSocketBase
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. def isSsl(): Boolean

    returns

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

    Definition Classes
    WebSocketWebSocketBase
  39. def localAddress(): SocketAddress

    returns

    the local address for this socket

    Definition Classes
    WebSocketWebSocketBase
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. def pause(): WebSocket

    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
    WebSocketWebSocketBaseReadStream
  44. 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
    WebSocketWebSocketBaseReadStream
  45. 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
    WebSocketWebSocketBaseReadStream
  46. 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
    WebSocketWebSocketBaseReadStream
  47. 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
    WebSocketWebSocketBaseReadStream
  48. 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

    Definition Classes
    WebSocketWebSocketBase
  49. def remoteAddress(): SocketAddress

    returns

    the remote address for this socket

    Definition Classes
    WebSocketWebSocketBase
  50. def resume(): WebSocket

    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
    WebSocketWebSocketBaseReadStream
  51. 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... * @param maxSize the max size of the write stream

    returns

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

    Definition Classes
    WebSocketWebSocketBaseWriteStream
  52. 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
    WebSocketWebSocketBase
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. 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
    WebSocketWebSocketBase
  55. 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

    Definition Classes
    WebSocketWebSocketBase
  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  60. def write(data: Buffer, handler: Handler[AsyncResult[Unit]]): WebSocket

    Same as but with an handler called when the operation completes

    Same as but with an handler called when the operation completes

    Definition Classes
    WebSocketWebSocketBaseWriteStream
  61. 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. * @param data the data to write

    returns

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

    Definition Classes
    WebSocketWebSocketBaseWriteStream
  62. def writeBinaryMessage(data: Buffer, handler: Handler[AsyncResult[Unit]]): WebSocket

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

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

    Definition Classes
    WebSocketWebSocketBase
  63. 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. * @param data the data to write

    returns

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

    Definition Classes
    WebSocketWebSocketBase
  64. def writeBinaryMessageFuture(data: Buffer): scala.concurrent.Future[Unit]

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

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

    Definition Classes
    WebSocketWebSocketBase
  65. def writeFinalBinaryFrame(data: Buffer, handler: Handler[AsyncResult[Unit]]): WebSocket

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

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

    Definition Classes
    WebSocketWebSocketBase
  66. def writeFinalBinaryFrame(data: Buffer): WebSocket

    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

    Definition Classes
    WebSocketWebSocketBase
  67. def writeFinalBinaryFrameFuture(data: Buffer): scala.concurrent.Future[Unit]

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

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

    Definition Classes
    WebSocketWebSocketBase
  68. def writeFinalTextFrame(text: String, handler: Handler[AsyncResult[Unit]]): WebSocket

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

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

    Definition Classes
    WebSocketWebSocketBase
  69. def writeFinalTextFrame(text: String): WebSocket

    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

    Definition Classes
    WebSocketWebSocketBase
  70. def writeFinalTextFrameFuture(text: String): scala.concurrent.Future[Unit]

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

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

    Definition Classes
    WebSocketWebSocketBase
  71. def writeFrame(frame: WebSocketFrame, handler: Handler[AsyncResult[Unit]]): WebSocket

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

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

    Definition Classes
    WebSocketWebSocketBase
  72. def writeFrame(frame: WebSocketFrame): WebSocket

    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

    Definition Classes
    WebSocketWebSocketBase
  73. def writeFrameFuture(frame: WebSocketFrame): scala.concurrent.Future[Unit]

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

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

    Definition Classes
    WebSocketWebSocketBase
  74. 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
    WebSocketWebSocketBaseWriteStream
  75. 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

    Definition Classes
    WebSocketWebSocketBase
  76. 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

    Definition Classes
    WebSocketWebSocketBase
  77. 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 * @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.WebSocket#setWriteQueueMaxSize * @return true if write queue is full

    Definition Classes
    WebSocketWebSocketBaseWriteStream
  78. def writeTextMessage(text: String, handler: Handler[AsyncResult[Unit]]): WebSocket

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

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

    Definition Classes
    WebSocketWebSocketBase
  79. 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. * @param text the data to write

    returns

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

    Definition Classes
    WebSocketWebSocketBase
  80. def writeTextMessageFuture(text: String): scala.concurrent.Future[Unit]

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

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

    Definition Classes
    WebSocketWebSocketBase

Inherited from WebSocketBase

Inherited from WriteStream[Buffer]

Inherited from ReadStream[Buffer]

Inherited from StreamBase

Inherited from AnyRef

Inherited from Any

Ungrouped