WebSocket
Baseline
Widely available
*
Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.
* Certaines parties de cette fonctionnalité peuvent bénéficier de prise en charge variables.
L'objet WebSocket fournit l'API qui permet de créer et de gérer une connexion WebSocket à un serveur ainsi que d'envoyer et de recevoir des données sur cette connexion.
Pour construire un objet WebSocket, on utilisera le constructeur WebSocket().
Note : Cette fonctionnalité est disponible via les Web Workers.
Constructeur
WebSocket(url[, protocols])-
Renvoie un nouvel objet
WebSocket.
Constantes
| Constante | Valeur |
WebSocket.CONNECTING |
0 |
WebSocket.OPEN |
1 |
WebSocket.CLOSING |
2 |
WebSocket.CLOSED |
3 |
Propriétés
WebSocket.binaryType-
Le type de données binaire utilisé par la connexion.
WebSocket.bufferedAmountLecture seule-
Le nombre d'octets de données dans la queue.
WebSocket.extensionsLecture seule-
Les extensions sélectionnées par le serveur.
WebSocket.onclose-
Un gestionnaire d'évènement à appeler lorsque la connexion est fermée.
WebSocket.onerror-
Un gestionnaire d'évènement à appeler en cas d'erreur.
WebSocket.onmessage-
Un gestionnaire d'évènement à appeler lors de la réception d'un message du serveur.
WebSocket.onopen-
Un gestionnaire d'évènement à appeler lorsque la connexion est ouverte.
WebSocket.protocolLecture seule-
Le sous-protocole sélectionné par le serveur.
WebSocket.readyStateLecture seule-
L'état courant de la connexion.
WebSocket.urlLecture seule-
L'URL absolue de la WebSocket.
Méthodes
WebSocket.close([code[, reason]])-
Ferme la connexion.
WebSocket.send(data)-
Ajoute des données à transmettre à la queue.
Évènements
close-
Déclenché lorsqu'une connexion avec une
WebSocketest fermée. Également disponible avec la propriétéonclose. error-
Déclenché lorsqu'une connexion avec une
WebSocketa été fermée à cause d'une erreur, par exemple lorsque des données n'ont pu être envoyées. Également disponible avec la propriétéonerror. message-
Déclenché lorsque des données sont reçues via une
WebSocket. Également disponible avec la propriétéonmessage. open-
Déclenché lorsqu'une connexion avec une
WebSocketest ouverte. Également disponible avec la propriétéonopen.
Exemples
// Créer une connexion WebSocket
const socket = new WebSocket("ws://localhost:8080");
// La connexion est ouverte
socket.addEventListener("open", function (event) {
socket.send("Coucou le serveur !");
});
// Écouter les messages
socket.addEventListener("message", function (event) {
console.log("Voici un message du serveur", event.data);
});
Spécifications
| Specification |
|---|
| WebSockets # the-websocket-interface |
Compatibilité des navigateurs
Chargement…