WebSocketExecute (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Execution contexts
Asynchronous operating mode

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

WebSocketExecute (Function)

In french: WebSocketExecute

Executes a global procedure in the context of a client connected to the WebSocket server.

Example

// Retrieve list of clients
arrClients is array of websocketClient = WebSocketListConnectedClient()
// Force the call to the SetInformation procedure in each client
sInformation is string = GetInformation()
FOR EACH Client OF arrClients
WebSocketExecute(Client, SetInformation)
// SetInformation is a global procedure that uses the sInformation variable
END

Syntax

WebSocketExecute(<Client> , <WLanguage procedure> [, <Parameters>])

<Client>: websocketClient variable

Name of the websocketClient variable corresponding to the client in which the procedure will be executed.

<WLanguage procedure>: Procedure name

Name of the global WLanguage procedure to be executed in the context of the client.

<Parameters>: List of values enclosed in brackets and separated by commas

Parameters of the procedure. This list of parameters has the following format:

(<Parameter 1>, ..., <Parameter N>)

where:
<Parameter 1>: First procedure parameter.
...
<Parameter N>: Nth procedure parameter.
Caution:
Parameters are passed by value.
Only simple types are allowed: Boolean, integer, ... For example, it is not possible to have a parameter corresponding to a class instance.
This parameter is only available from Update 1.

Remarks

Execution contexts

The global service of the WebSocket server and the connected clients are executed independently. Each is executed in its own context with:

its own copy of global variables.
its own database context.
etc.

Therefore, it is not possible to handle the global context or the context of another client.

WebSocketExecute is used to execute the WLanguage procedure passed as parameter in the context of another client. During the execution of the procedure, the global variables will be those of the target client.

Asynchronous operating mode

The operating mode is asynchronous: the function simply requests the execution of the procedure. The procedure can actually be executed later (after WebSocketExecute has been executed). WebSocketExecute never returns an error (for example, if the client has been disconnected in the meantime).

Business / UI classification: Business Logic

Component: wd270awws.dll