socketio-kotlin

2.2.0

socketio-kotlin/org.hildan.socketio/EngineIOPacket

EngineIOPacket

sealed interface EngineIOPacket<out T>(source)

An Engine.IO packet, as defined in the Engine.IO protocol.

Inheritors

Types

data class BinaryData(val payload: ByteString) : EngineIOPacket<Nothing>

Raw binary data sent as a pure binary web socket frame, or as a base64 record in HTTP long-polling mode.

data object Close : EngineIOPacket<Nothing>

Used to indicate that a transport can be closed.

data class Message<T>(val payload: T) : EngineIOPacket<T>

Used to send a text payload to the other side.

data object Noop : EngineIOPacket<Nothing>

Used during the upgrade process.

@Serializable

data class Open(val sid: String, val upgrades: List<String>, val pingInterval: Int, val pingTimeout: Int, val maxPayload: Int? = null) : EngineIOPacket<Nothing>

Used during the handshake.

data class Ping(val payload: String?) : EngineIOPacket<Nothing>

Used in the heartbeat mechanism.

data class Pong(val payload: String?) : EngineIOPacket<Nothing>

Used in the heartbeat mechanism.

data object Upgrade : EngineIOPacket<Nothing>

Used during the upgrade process.