io.ktor.http.cio.websocket

Class Frame.Text

Frame

io.ktor.http.cio.websocket.Frame.Text

Enclosing class:

Frame

public static class Frame.Text
extends Frame

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.

Nested Class Summary

Nested classes/interfaces inherited from class io.ktor.http.cio.websocket.Frame

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

Field Summary

Fields inherited from class io.ktor.http.cio.websocket.Frame

Companion

Constructor Summary

Constructors

Constructor and Description
Text(boolean fin, java.nio.ByteBuffer buffer) 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.
Text(java.lang.String text)
Text(boolean fin, kotlinx.io.core.ByteReadPacket packet)

Method Summary

Methods inherited from class io.ktor.http.cio.websocket.Frame

copy, getBuffer, getDisposableHandle, getFin, getFrameType, toString

Constructor Detail

Text

public Text(boolean fin,
            java.nio.ByteBuffer buffer)

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.

Text

public Text(java.lang.String text)

Text

public Text(boolean fin,
            kotlinx.io.core.ByteReadPacket packet)