ktor-websockets/io.ktor.websocket/Frame/Ping

Ping

expect class Ping(data: ByteArray) : Frame(source)

Represents a low-level ping frame. Could be sent to test connection (peer should reply with Pong). Usually there is no need to send/handle it unless you have a RAW WebSocket session.

Note: a control frame payload must not exceed 125 bytes (RFC 6455 §5.5); constructing a larger one throws IllegalArgumentException.

Report a problem

actual class Ping(data: ByteArray) : Frame(source)

Represents a low-level ping frame. Could be sent to test connection (peer should reply with Pong). Usually there is no need to send/handle it unless you have a RAW web socket session.

Report a problem

actual class Ping(data: ByteArray) : Frame(source)

Represents a low-level ping frame. Could be sent to test connection (peer should reply with Pong). Usually there is no need to send/handle it unless you have a RAW web socket session.

Report a problem

Constructors

expect constructor(data: ByteArray)

expect constructor(packet: Source)

constructor(buffer: ByteBuffer)

actual constructor(data: ByteArray)

actual constructor(packet: Source)

actual constructor(data: ByteArray)

actual constructor(packet: Source)

Properties

val buffer: ByteBuffer

Frame content

expect val data: ByteArray

actual val data: ByteArray

actual val data: ByteArray

disposableHandle

expect val disposableHandle: DisposableHandle

could be invoked when the frame is processed

actual val disposableHandle: DisposableHandle

could be invoked when the frame is processed

actual val disposableHandle: DisposableHandle

could be invoked when the frame is processed

expect val fin: Boolean

is it final fragment, should be always true for control frames and if no fragmentation is used

actual val fin: Boolean

is it final fragment, should be always true for control frames and if no fragmentation is used

actual val fin: Boolean

is it final fragment, should be always true for control frames and if no fragmentation is used

expect val frameType: FrameType

enum value

actual val frameType: FrameType

enum value

actual val frameType: FrameType

enum value

expect val rsv1: Boolean

First extension bit.

actual val rsv1: Boolean

First extension bit.

actual val rsv1: Boolean

First extension bit.

expect val rsv2: Boolean

Second extension bit.

actual val rsv2: Boolean

Second extension bit.

actual val rsv2: Boolean

Second extension bit.

expect val rsv3: Boolean

Third extension bit.

actual val rsv3: Boolean

Third extension bit.

actual val rsv3: Boolean

Third extension bit.

Functions

expect fun copy(): Frame

Creates a frame copy.

actual fun copy(): Frame

Creates a frame copy.

actual fun copy(): Frame

Creates a frame copy.

fun Frame.readBytes(): ByteArray

Reads binary content from the frame. For fragmented frames only returns this fragment.

open override fun toString(): String

open override fun toString(): String