ktor-http-cio / io.ktor.http.cio.websocket / Frame / Ping

Ping

class Ping : Frame

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.

Constructors

<init>

Ping(packet: ByteReadPacket)Ping(buffer: ByteBuffer)

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.

Inherited Properties

buffer

val buffer: ByteBuffer
  • a frame content or fragment content

disposableHandle

val disposableHandle: DisposableHandle

could be invoked when the frame is processed

fin

val fin: Boolean

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

frameType

val frameType: FrameType

enum value

Inherited Functions

copy

fun copy(): Frame

Creates a frame copy

toString

open fun toString(): String