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

BinaryEvent

data class BinaryEvent(val namespace: String, val ackId: Int?, val payload: List<PayloadElement>, val nBinaryAttachments: Int) : SocketIOPacket.BinaryMessage(source)

Used to send binary data to the other side.

Constructors

BinaryEvent

constructor(namespace: String, ackId: Int?, payload: List<PayloadElement>, nBinaryAttachments: Int)

Properties

ackId

open override 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

open override val namespace: String

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

nBinaryAttachments

open override val nBinaryAttachments: Int

The number of binary attachments that follow this message.

payload

open override 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.