WebSocket

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

* Some parts of this feature may have varying levels of support.

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.bufferedAmount Lecture seule

Le nombre d'octets de données dans la queue.

WebSocket.extensions Lecture 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.protocol Lecture seule

Le sous-protocole sélectionné par le serveur.

WebSocket.readyState Lecture seule

L'état courant de la connexion.

WebSocket.url Lecture 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 WebSocket est fermée. Également disponible avec la propriété onclose.

error

Déclenché lorsqu'une connexion avec une WebSocket a é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 WebSocket est ouverte. Également disponible avec la propriété onopen.

Exemples

js
// 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 Standard
# the-websocket-interface

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi