WebSocket

Baseline Large disponibilité *

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.

Note : Cette fonctionnalité est disponible via les Web Workers.

L'objet WebSocket fournit l'API permettant de créer et de gérer une connexion WebSocket avec un serveur, ainsi que d'envoyer et de recevoir des données sur cette connexion.

Pour construire un WebSocket, utilisez le constructeur WebSocket().

Note : L'API WebSocket n'a aucun moyen d'appliquer la rétropression, donc lorsque les messages arrivent plus vite que l'application ne peut les traiter, l'application va soit remplir la mémoire de l'appareil en mettant ces messages en mémoire tampon, soit devenir non réactive à cause d'une utilisation du processeur à 100 %, ou les deux. Pour une alternative qui fournit automatiquement la rétropression, voir WebSocketStream.

EventTarget WebSocket

Dans cet article

Constructeur

WebSocket()

Retourne un nouvel objet WebSocket.

Propriétés d'instance

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 file d'attente.

WebSocket.extensions Lecture seule

Les extensions sélectionnées par le serveur.

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 d'instance

WebSocket.close()

Ferme la connexion.

WebSocket.send()

Ajoute des données à transmettre à la file d'attente.

Évènements

Écoutez ces évènements avec addEventListener() ou en assignant un gestionnaire à la propriété oneventname de cette interface.

Déclenché lorsqu'une connexion avec une WebSocket est fermée. Également disponible via 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 via la propriété onerror.

message

Déclenché lorsque des données sont reçues via une WebSocket. Également disponible via la propriété onmessage.

open

Déclenché lorsqu'une connexion avec une WebSocket est ouverte. Également disponible via 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", (event) => {
  socket.send("Coucou le serveur !");
});

// Écouter les messages
socket.addEventListener("message", (event) => {
  console.log("Voici un message du serveur", event.data);
});