socketio-kotlin/org.hildan.socketio/SocketIOPacket/BinaryMessage

BinaryMessage

sealed interface BinaryMessage : SocketIOPacket.Message(source)

Inheritors

Properties

abstract val ackId: Int?

An ID used to match an Event with the corresponding Ack. When an ackId is present in an Event packet, it means an Ack packet is expected by the sender.

namespace

abstract val namespace: String

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

nBinaryAttachments

abstract val nBinaryAttachments: Int

The number of binary attachments that follow this message.

payload

abstract val payload: List<PayloadElement>

The payload of the message, which must be a non-empty array. Usually the first element of the array is the event type (string or int), and the rest is the actual data.