Help / WLanguage / WLanguage functions / Communication / WebSocket
  • Properties specific to websocketClient variables
  • WLanguage functions that use the websocketClient type
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
websocketClient (Type of variable)
In french: websocketClient
AjaxNot available
The websocketClient type is used to identify and define all the advanced characteristics of a client connected to a WebSocket server. The characteristics of this client can be defined and changed using different WLanguage properties.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
// Retrieve list of clients
arrClients is array of websocketClient = WebSocketListConnectedClient()
// To send a message to each client
FOR EACH oClient OF arrClients
WebSocketSend(oClient, bufMessage)

Properties specific to websocketClient variables

The following properties can be used to handle clients connected to a WebSocket server:
Property nameType usedEffect
  • True if the client is still connected,
  • False otherwise.
This property is read-only.
IPCharacter stringClient IP address.
This property is read-only.
NoteAll typesBusiness logic data associated with this client. This data is written through programming, to be reused later. The default value is an empty string ("").
Using this property, the global context or another client can obtain information about this client.

WLanguage functions that use the websocketClient type

WebSocketDisconnectDisconnects a client from a WebSocket server.
WebSocketExecuteExecutes a procedure in the context of a client connected to the WebSocket server.
WebSocketSendSends a message from the WebSocket server to the client.
Minimum version required
  • Version 26
This page is also available for…
Click [Add] to post a comment

Last update: 01/26/2023

Send a report | Local help