interface WebSocketBase : ReadStream<Buffer>, WriteStream<Buffer>
Base WebSocket implementation.
It implements both and so it can be used with io.vertx.reactivex.core.streams.Pump to pump data with flow control.
NOTE: This class has been automatically generated from the io.vertx.core.http.WebSocketBase non RX-ified interface using Vert.x codegen.
abstract fun binaryHandlerID(): String
When a 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. |
|
abstract fun binaryMessageHandler(handler: Handler<Buffer>): WebSocketBase
Set a binary message handler on the connection. This handler serves a similar purpose to |
|
abstract fun close(): Unit
Close the WebSocket. |
|
abstract fun closeHandler(handler: Handler<Void>): WebSocketBase
Set a close handler. This will be called when the WebSocket is closed. |
|
abstract fun drainHandler(handler: Handler<Void>): WebSocketBase |
|
abstract fun end(t: Buffer): Unit
Same as abstract fun end(): Unit
|
|
abstract fun endHandler(endHandler: Handler<Void>): WebSocketBase |
|
abstract fun exceptionHandler(handler: Handler<Throwable>): WebSocketBase |
|
abstract fun frameHandler(handler: Handler<WebSocketFrame>): WebSocketBase
Set a frame handler on the connection. This handler will be called when frames are read on the connection. |
|
abstract fun getDelegate(): WebSocketBase |
|
abstract fun handler(handler: Handler<Buffer>): WebSocketBase |
|
abstract fun isSsl(): Boolean |
|
abstract fun localAddress(): SocketAddress |
|
open static fun newInstance(arg: WebSocketBase): WebSocketBase |
|
abstract fun pause(): WebSocketBase |
|
abstract fun pongHandler(handler: Handler<Buffer>): WebSocketBase
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. |
|
abstract fun remoteAddress(): SocketAddress |
|
abstract fun resume(): WebSocketBase |
|
abstract fun setWriteQueueMaxSize(maxSize: Int): WebSocketBase |
|
abstract fun subProtocol(): String
Returns the websocket sub protocol selected by the websocket handshake. On the server, the value will be |
|
abstract fun textHandlerID(): String
When a 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. |
|
abstract fun textMessageHandler(handler: Handler<String>): WebSocketBase
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 |
|
abstract fun write(data: Buffer): WebSocketBase |
|
abstract fun writeBinaryMessage(data: Buffer): WebSocketBase
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. |
|
abstract fun writeFinalBinaryFrame(data: Buffer): WebSocketBase
Write a final WebSocket binary frame to the connection |
|
abstract fun writeFinalTextFrame(text: String): WebSocketBase
Write a final WebSocket text frame to the connection |
|
abstract fun writeFrame(frame: WebSocketFrame): WebSocketBase
Write a WebSocket frame to the connection |
|
abstract fun writePing(data: Buffer): WebSocketBase
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. |
|
abstract fun writePong(data: Buffer): WebSocketBase
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. |
|
abstract fun writeQueueFull(): Boolean
This will return |
|
abstract fun writeTextMessage(text: String): WebSocketBase
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. |
abstract fun toFlowable(): Flowable<T> |
|
abstract fun toObservable(): Observable<T> |
open class ServerWebSocket : WebSocketBase
Represents a server side WebSocket. Instances of this class are passed into a |
|
open class WebSocket : WebSocketBase
Represents a client-side WebSocket. NOTE: This class has been automatically generated from the io.vertx.core.http.WebSocket non RX-ified interface using Vert.x codegen. |