WebSocketConnection
L'API de la classe WebSocketConnection vous permet de gérer les connexions WebSocket, une fois qu'elles ont été établies à l'aide de la classe WebSocketServer.
Pour une vue d'ensemble et quelques exemples de la mise en œuvre du serveur WebSocket dans 4D, veuillez vous référer à la classe WebSocketServer.
Historique
| Release | Modifications |
|---|---|
| 20 | Ajout |
Objet WebSocketConnection
Un objet WebSocketConnection est automatiquement créé lorsque la fonction de callback WSHandler.onConnection de l'objet WebSocketServer renvoie un objet connectionHandler.
Les objets WebSocketConnection offrent les propriétés et fonctions suivantes :
| .handler : Object l'accesseur qui récupère l'objet connectionHandler utilisé pour initier la connexion |
| .id : Integer l'identifiant unique de la connexion |
| .send( message : Text ) .send( message : Blob ) .send( message : Object ) envoie message au client |
| .status : Text le statut de la connexion (peut être "Closing", "Closed" ou "Connected") |
| .terminate( { code : Integer ; message : Text } ) force la fermeture de la connexion |
| .wss : 4D.WebSocketServer l'objet parent WebSocketServer de la connexion |
.handler
.handler : Object
Description
La propriété .handler contient l'accesseur qui récupère l'objet connectionHandler utilisé pour initier la connexion.
.id
.id : Integer
Description
La propriété .id contient l'identifiant unique de la connexion.
Cette propriété est en lecture seule.
.send()
.send( message : Text )
.send( message : Blob )
.send( message : Object )
| Paramètres | Type | Description | |
|---|---|---|---|
| message | Text, Blob, Object | -> | Le message à envoyer |
Description
La fonction .send() envoie message au client.
Les contenus suivants sont envoyés en fonction du type de message :
| Type | Contenu |
|---|---|
| Text | Texte en UTF-8 |
| Blob | Données binaires |
| Object | Texte en JSON UTF-8 (même résultat qu'avec JSON Stringify) |
.status
.status : Text
Description
La propriété .status contient le statut de la connexion (peut être "Closing", "Closed" ou "Connected").
Cette propriété est en lecture seule.
.terminate()
.terminate( { code : Integer ; message : Text } )
| Paramètres | Type | Description | |
|---|---|---|---|
| code | Integer | -> | Code d'erreur envoyé au client (doit être > 3000, sinon le message n'est pas envoyé) |
| message | Text | -> | Message d'erreur envoyé au client |
Description
La fonction .terminate() force la fermeture de la connexion.
Un code et un message peuvent être envoyés au client pendant la fermeture pour indiquer la raison de la fermeture.
.wss
.wss : 4D.WebSocketServer
Description
La propriété .wss contient l'objet parent WebSocketServer de la connexion.
Cette propriété est en lecture seule.