IPWorks WebSockets 2020 Kotlin Edition

Questions / Feedback?

DataFormat Property

The format of the data being sent.

Syntax

public var dataFormat: WebsocketclientDataFormats

public enum class WebsocketclientDataFormats(val value: Int) {
dfAutomatic(0),
dfText(1),
dfBinary(2),
dfPing(9),
dfPong(10);
}

Default Value

0

Remarks

When data is sent over an established connection it is usually considered as text or binary data. Text data is UTF-8 encoded. Binary data has no encoding associated with it.

Possible values are:

0 (dfAutomatic - default) The component will attempt to automatically determine the correct data format. This is suitable for most cases.
1 (dfText) The component will UTF-8 encode the specified data before sending. Data that has already been UTF-8 encoded may also be supplied.
2 (dfBinary) The component will send the data exactly as it is provided.
9 (dfPing) The component will send the ping with data exactly as it is provided.
10 (dfPong) The component will send the pong with data exactly as it is provided.

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