socketio-kotlin/org.hildan.socketio/SocketIOPacket

SocketIOPacket

sealed class SocketIOPacket(source)

A Socket.IO packet, as defined in the Socket.IO protocol.

Exact payload types can be checked against the reference implementation.

Inheritors

Types

data class Ack(val namespace: String, val ackId: Int, val payload: JsonArray) : SocketIOPacket.Message

Used to acknowledge the event with the corresponding ackId.

data class Connect(val namespace: String, val payload: JsonObject?) : SocketIOPacket

Used during the connection to a namespace.

data class ConnectError(val namespace: String, val errorData: JsonElement?) : SocketIOPacket

Used during the connection to a namespace.

data class Disconnect(val namespace: String) : SocketIOPacket

Used when disconnecting from a namespace.

data class Event(val namespace: String, val ackId: Int?, val payload: JsonArray) : SocketIOPacket.Message

Used to send data to the other side.

sealed class Message : SocketIOPacket

A parent for packet types having a payload.

Properties

abstract val namespace: String

The namespace this packet belongs to, useful when multiplexing. The default namespace is "/".