websocketClient (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

New WINDEV and WEBDEV 26 feature!

Properties specific to the description of websocketClient variables
WLanguage functions that use the websocketClient type

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

websocketClient (Type of variable)

In french: websocketClient

Not 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 modified using different WLanguage properties.

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

Example

// Retrieves the list of customers
arrClients is array of websocketClient = WebSocketListConnectedClient()
// To send a message to each client
FOR EACH oClient OF arrClients
WebSocketSend(oClient, bufMessage)
END

Remarks

Properties specific to the description of websocketClient variables

The following properties can be used to handle clients connected to a WebSocket server:

Property name	Type used	Effect

Connected	Boolean	True if the client is still connected, False otherwise. This property is available in read-only mode.
IP	Character string	Client IP address. This property is available in read-only mode.
Note	All types	Business logic data associated with this client. This data is written by 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


Versions 26 and later WebSocketDisconnect New in version 26 WebSocketDisconnect WebSocketDisconnect	Disconnects a client from a WebSocket server.
Versions 26 and later WebSocketExecute New in version 26 WebSocketExecute WebSocketExecute	Executes a global procedure in the context of a client connected to the WebSocket server.
Versions 26 and later WebSocketSend New in version 26 WebSocketSend WebSocketSend	Sends a message from the WebSocket server to the client.