vertx / io.vertx.reactivex.core.http / WebSocketFrame

WebSocketFrame

open class WebSocketFrame

A WebSocket frame that represents either text or binary data.

A WebSocket message is composed of one or more WebSocket frames.

If there is a just a single frame in the message then a single text or binary frame should be created with final = true.

If there are more than one frames in the message, then the first frame should be a text or binary frame with final = false, followed by one or more continuation frames. The last continuation frame should have final = true.

NOTE: This class has been automatically generated from the io.vertx.core.http.WebSocketFrame non RX-ified interface using Vert.x codegen.

Constructors

<init>

WebSocketFrame(delegate: WebSocketFrame)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<WebSocketFrame>

Functions

binaryData

open fun binaryData(): Buffer

binaryFrame

open static fun binaryFrame(data: Buffer, isFinal: Boolean): WebSocketFrame

Create a binary WebSocket frame.

closeReason

open fun closeReason(): String

closeStatusCode

open fun closeStatusCode(): Short

continuationFrame

open static fun continuationFrame(data: Buffer, isFinal: Boolean): WebSocketFrame

Create a continuation frame

equals

open fun equals(other: Any?): Boolean

getDelegate

open fun getDelegate(): WebSocketFrame

hashCode

open fun hashCode(): Int

isBinary

open fun isBinary(): Boolean

isClose

open fun isClose(): Boolean

isContinuation

open fun isContinuation(): Boolean

isFinal

open fun isFinal(): Boolean

isText

open fun isText(): Boolean

newInstance

open static fun newInstance(arg: WebSocketFrame): WebSocketFrame

pingFrame

open static fun pingFrame(data: Buffer): WebSocketFrame

Create a ping WebSocket frame. Will be a final frame. There is no option for non final ping frames.

pongFrame

open static fun pongFrame(data: Buffer): WebSocketFrame

Create a pong WebSocket frame. Will be a final frame. There is no option for non final pong frames.

textData

open fun textData(): String

textFrame

open static fun textFrame(str: String, isFinal: Boolean): WebSocketFrame

Create a text WebSocket frame.

toString

open fun toString(): String