IPWorks WebSockets 2020 Kotlin Edition

Questions / Feedback?

DataIn Event

Fired when data is received.

Syntax

public open class DefaultWebsocketserverEventListener : WebsocketserverEventListener {
  ...
  public override fun dataIn(e: WebsocketserverDataInEvent) {}
  ...
}

public class WebsocketserverDataInEvent {
  val connectionId: String?
  val dataFormat: Int
  val text: ByteArray?
  val eom: Boolean
}

Remarks

The DataIn event provides the data received from the client identified by the ConnectionId parameter.

The incoming data is provided through the Text parameter.

The DataFormat parameter identifies the encoding (if any) of the data. Possible value are:

1 The data is UTF-8 encoded.
2 The data is binary and has no encoding.
10 The data is a pong packet.

The EOM parameter stands for End Of Message. By default the component will fire the DataIn event as data is received. Larger messages will be fragmented and will cause the event to fire multiple times. When EOM is true within the event this indicates the current fragment is also the final fragment of the message. The component may also be configured to buffer the message internally until the complete message is received. To enable this set BufferMessage to true.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 Kotlin Edition - Version 20.0 [Build 7721]