io.ktor.http.cio.websocket

Class Frame

io.ktor.http.cio.websocket.Frame

Direct Known Subclasses:

Frame.Binary, Frame.Close, Frame.Ping, Frame.Pong, Frame.Text

public class Frame

A frame received or ready to be sent. It is not reusable and not thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Frame.Binary Represents an application level binary frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Note that usually there is no need to handle fragments unless you have a RAW web socket session.
static class	Frame.Close Represents a low-level level close frame. It could be sent to indicate web socket session end. Usually there is no need to send/handle it unless you have a RAW web socket session.
static class	Frame.Companion
static class	Frame.Ping Represents a low-level ping frame. Could be sent to test connection (peer should reply with class Frame.Pong). Usually there is no need to send/handle it unless you have a RAW web socket session.
static class	Frame.Pong Represents a low-level pong frame. Should be sent in reply to a class Frame.Ping frame. Usually there is no need to send/handle it unless you have a RAW web socket session.
static class	Frame.Text Represents an application level text frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Please note that a boundary between fragments could be in the middle of multi-byte (unicode) character so don't apply String constructor to every fragment but use decoder loop instead of concatenate fragments first. Note that usually there is no need to handle fragments unless you have a RAW web socket session.

Field Summary

Fields

Modifier and Type	Field and Description
static Frame.Companion	Companion

Method Summary

Modifier and Type	Method and Description
Frame	copy() Creates a frame copy
java.nio.ByteBuffer	getBuffer() a frame content or fragment content
kotlinx.coroutines.DisposableHandle	getDisposableHandle() could be invoked when the frame is processed
boolean	getFin() is it final fragment,
FrameType	getFrameType() enum value
java.lang.String	toString()

Field Detail

Companion

public static Frame.Companion Companion

Method Detail

toString

public java.lang.String toString()

copy

public Frame copy()

Creates a frame copy

getFin

public boolean getFin()

is it final fragment,

should be always true for control frames and if no fragmentation is used

getFrameType

public FrameType getFrameType()

enum value

getBuffer

public java.nio.ByteBuffer getBuffer()

• a frame content or fragment content

getDisposableHandle

public kotlinx.coroutines.DisposableHandle getDisposableHandle()

could be invoked when the frame is processed