From 9a7bf38a2e1551841b9fe1721e232defb3a1177a Mon Sep 17 00:00:00 2001 From: SphinxKnight Date: Fri, 17 Sep 2021 23:39:32 +0200 Subject: Revamps WS landing page - translates WS interface subpages - fixes #2139 (#2271) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Revamps WS landing page - translates WS interface subpages - fixes #2139 * Ajout espace insécable Co-authored-by: Jb Audras --- files/fr/web/api/websocket/binarytype/index.html | 54 ++++ .../fr/web/api/websocket/bufferedamount/index.html | 26 ++ files/fr/web/api/websocket/close/index.html | 45 +++ files/fr/web/api/websocket/close_event/index.html | 87 +++--- files/fr/web/api/websocket/error_event/index.html | 57 ++++ files/fr/web/api/websocket/extensions/index.html | 26 ++ files/fr/web/api/websocket/index.html | 309 +++++---------------- .../fr/web/api/websocket/message_event/index.html | 57 ++++ files/fr/web/api/websocket/onclose/index.html | 27 ++ files/fr/web/api/websocket/onerror/index.html | 35 +++ files/fr/web/api/websocket/onmessage/index.html | 27 ++ files/fr/web/api/websocket/onopen/index.html | 27 ++ files/fr/web/api/websocket/open_event/index.html | 57 ++++ files/fr/web/api/websocket/protocol/index.html | 26 ++ files/fr/web/api/websocket/readystate/index.html | 56 ++++ files/fr/web/api/websocket/send/index.html | 55 ++++ files/fr/web/api/websocket/url/index.html | 26 ++ files/fr/web/api/websocket/websocket/index.html | 42 +++ 18 files changed, 749 insertions(+), 290 deletions(-) create mode 100644 files/fr/web/api/websocket/binarytype/index.html create mode 100644 files/fr/web/api/websocket/bufferedamount/index.html create mode 100644 files/fr/web/api/websocket/close/index.html create mode 100644 files/fr/web/api/websocket/error_event/index.html create mode 100644 files/fr/web/api/websocket/extensions/index.html create mode 100644 files/fr/web/api/websocket/message_event/index.html create mode 100644 files/fr/web/api/websocket/onclose/index.html create mode 100644 files/fr/web/api/websocket/onerror/index.html create mode 100644 files/fr/web/api/websocket/onmessage/index.html create mode 100644 files/fr/web/api/websocket/onopen/index.html create mode 100644 files/fr/web/api/websocket/open_event/index.html create mode 100644 files/fr/web/api/websocket/protocol/index.html create mode 100644 files/fr/web/api/websocket/readystate/index.html create mode 100644 files/fr/web/api/websocket/send/index.html create mode 100644 files/fr/web/api/websocket/url/index.html create mode 100644 files/fr/web/api/websocket/websocket/index.html diff --git a/files/fr/web/api/websocket/binarytype/index.html b/files/fr/web/api/websocket/binarytype/index.html new file mode 100644 index 0000000000..f9dc94bbb4 --- /dev/null +++ b/files/fr/web/api/websocket/binarytype/index.html @@ -0,0 +1,54 @@ +--- +title: WebSocket.binaryType +slug: Web/API/WebSocket/binaryType +browser-compat: api.WebSocket.binaryType +--- +

{{APIRef("Web Sockets API")}}

+ +

La propriété WebSocket.binaryType contrôle le type de données binaires reçues via la connexion WebSocket.

+ +

Syntaxe

+ +
+var binaryType = aWebSocket.binaryType;
+
+ +

Valeur

+ +

Une chaîne de caractères DOMString ayant l'une de ces deux valeurs :

+ +
+
"blob"
+
Utilise des objets Blob pour les données binaires. Il s'agit de la valeur par défaut.
+
"arraybuffer"
+
Utilise des objets ArrayBuffer pour les données binaires. +
+
+ +

Exemples

+ +
+// On crée une connexion WebSocket connection.
+const socket = new WebSocket("ws://localhost:8080");
+// On change le type de données binaires de "blob" à "arraybuffer"
+socket.binaryType = "arraybuffer";
+
+// On écoute les différents messages
+socket.addEventListener("message", function (event) {
+  if(event.data instanceof ArrayBuffer) {
+    // Frame de données binaires
+    const view = new DataView(event.data);
+    console.log(view.getInt32(0));
+  } else {
+    // Frame textuelle
+    console.log(event.data);
+  }
+});
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/bufferedamount/index.html b/files/fr/web/api/websocket/bufferedamount/index.html new file mode 100644 index 0000000000..c4492c5c61 --- /dev/null +++ b/files/fr/web/api/websocket/bufferedamount/index.html @@ -0,0 +1,26 @@ +--- +title: WebSocket.bufferedAmount +slug: Web/API/WebSocket/bufferedAmount +browser-compat: api.WebSocket.bufferedAmount +--- +

{{APIRef("Web Sockets API")}}

+ +

La propriété en lecture seule WebSocket.bufferedAmount renvoie le nombre d'octets de données qui ont été placées dans la queue via des appels à send() mais qui n'ont pas encore été transmises sur le réseau. Cette valeur est réinitialisée à zéro lorsque toutes les données ont été envoyées. Cette valeur n'est pas remise à zéro lorsque la connexion est fermée. Des appels successifs à send() feront croître cette valeur.

+ +

Syntaxe

+ +
+var bufferedAmount = aWebSocket.bufferedAmount;
+
+ +

Valeur

+ +

Un nombre au format unsigned long.

+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/close/index.html b/files/fr/web/api/websocket/close/index.html new file mode 100644 index 0000000000..09621ca71b --- /dev/null +++ b/files/fr/web/api/websocket/close/index.html @@ -0,0 +1,45 @@ +--- +title: WebSocket.close() +slug: Web/API/WebSocket/close +browser-compat: api.WebSocket.close +--- +

{{APIRef("Web Sockets API")}}

+ +

La méthode WebSocket.close() ferme la connexion WebSocket ou interrompt l'éventuelle tentative de connexion. Si la connexion est déjà fermée (état CLOSED), cette méthode ne fait rien.

+ +

Syntaxe

+ +
WebSocket.close();
+
WebSocket.close(code);
+
WebSocket.close(reason);
+
WebSocket.close(code, reason);
+ +

Paramètres

+ +
+
code {{optional_inline}}
+
Une valeur numérique indiquant le code de statut qui explique pourquoi la connexion est fermée. Si ce paramètre n'est pas fourni, 1005 sera la valeur par défaut. Voir la liste des codes de statut de CloseEvent pour les valeurs autorisées.
+
reason {{optional_inline}}
+
Une chaîne de caractères, lisible et compréhensible par un humain qui explique pourquoi la connexion est fermée. Cette chaîne ne doit pas être plus longue que 123 octets de texte UTF-8 (attention, cela ne signifie pas 123 caractères).
+
+ +

Exceptions levées

+ +
+
INVALID_ACCESS_ERR
+
Un code invalide a été fourni avec code.
+
SYNTAX_ERR
+
La chaîne de caractères pour reason est trop longue ou contient des surrogates non appairés.
+
+ +
+

Note : Avant Gecko 8.0, cette méthode ne prenait en charge aucun paramètre.

+
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/close_event/index.html b/files/fr/web/api/websocket/close_event/index.html index f1ed8b2ff0..e09d0bb1db 100644 --- a/files/fr/web/api/websocket/close_event/index.html +++ b/files/fr/web/api/websocket/close_event/index.html @@ -1,72 +1,61 @@ --- -title: close +title: 'WebSocket : évènement close' slug: Web/API/WebSocket/close_event +browser-compat: api.WebSocket.close_event translation_of: Web/API/WebSocket/close_event --- -

Le gestionnaire de fermuture (close) est exécuté lorsqu'une connexion avec un socket Web est fermée.

+
{{APIRef}}
-

Informations générales

+

L'évènement close est déclenché lorsqu'une connexion avec une WebSocket est fermée.

-
-
Spécification
-
WebSocket
-
Interface
-
Event
-
Propagation
-
Non
-
Annulable
-
Non
-
Cible
-
WebSocket
-
Action par défaut
-
Aucune
-
- -

Propriétés

- - - - - - - - - +
PropertyTypeDescription
- - - + + - - - + + - - - + + - - - + +
target {{readonlyInline}}{{domxref("EventTarget")}}The event target (the topmost target in the DOM tree).Bouillonne/RemonteNon
type {{readonlyInline}}{{domxref("DOMString")}}The type of event.AnnulableNon
bubbles {{readonlyInline}}{{jsxref("Boolean")}}Whether the event normally bubbles or not.InterfaceCloseEvent
cancelable {{readonlyInline}}{{jsxref("Boolean")}}Whether the event is cancellable or not.Propriété de gestionnaire d'évènement correspondanteonclose
-

Evénements liés

+

Exemples

- +

On peut vouloir savoir lorsque la connexion a été fermée afin de mettre à jour l'interface utilisateur ou, éventuellement, pour sauvegarder des données à propos de la connexion. Soit une variable socketExemple qui fait référence à une connexion WebSocket ouverte, le fragment de code suivant gère la situation où la socket a été fermée :

+ +
socketExemple.addEventListener('close', (event) => {
+  console.log('La connexion a été fermée avec succès.');
+});
+ +

On peut effectuer les mêmes actions avec la propriété de gestion d'évènement correspondante :

+ +
socketExemple.onclose = function (event) {
+  console.log('La connexion a été fermée avec succès.');
+};
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

-

Voir aussi

+

Voir aussi

diff --git a/files/fr/web/api/websocket/error_event/index.html b/files/fr/web/api/websocket/error_event/index.html new file mode 100644 index 0000000000..91bb314dde --- /dev/null +++ b/files/fr/web/api/websocket/error_event/index.html @@ -0,0 +1,57 @@ +--- +title: 'WebSocket : évènement error' +slug: Web/API/WebSocket/error_event +browser-compat: api.WebSocket.error_event +--- +
{{APIRef}}
+ +

L'évènement error est 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).

+ + + + + + + + + + + + + + + + + + + + +
Bouillonne/RemonteNon
AnnulableNon
InterfaceEvent
Propriété de gestionnaire d'évènement correspondanteonerror
+ +

Exemples

+ +
+// On crée une connexion WebSocket
+const socket = new WebSocket('ws://localhost:8080');
+
+// On écoute les éventuelles erreurs
+socket.addEventListener('error', function (event) {
+  console.log('Erreur WebSocket : ', event);
+});
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

+ +

Voir aussi

+ + diff --git a/files/fr/web/api/websocket/extensions/index.html b/files/fr/web/api/websocket/extensions/index.html new file mode 100644 index 0000000000..5846b29953 --- /dev/null +++ b/files/fr/web/api/websocket/extensions/index.html @@ -0,0 +1,26 @@ +--- +title: WebSocket.extensions +slug: Web/API/WebSocket/extensions +browser-compat: api.WebSocket.extensions +--- +

{{APIRef("Web Sockets API")}}

+ +

La propriété en lecture seule WebSocket.extensions renvoie les extensions sélectionnées par le serveur. Actuellement, cette propriété vaut une chaîne de caractères vide ou la liste des extensions négociées par la connexion.

+ +

Syntaxe

+ +
+var extensions = aWebSocket.extensions;
+
+ +

Valeur

+ +

Une chaîne de caractères DOMString.

+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/index.html b/files/fr/web/api/websocket/index.html index d9aa659440..45acf344a3 100644 --- a/files/fr/web/api/websocket/index.html +++ b/files/fr/web/api/websocket/index.html @@ -1,298 +1,125 @@ --- title: WebSocket slug: Web/API/WebSocket -tags: - - API - - WebSocket - - WebSockets +browser-compat: api.WebSocket translation_of: Web/API/WebSocket --- -

{{APIRef("Web Sockets API")}}{{ SeeCompatTable() }}

+
{{APIRef("Web Sockets API")}}
-

L'objet WebSocket fournit une API permettant la création et la gestion d'une connexion WebSocket avec un serveur, ainsi que l'émission et la réception de données par l'intermédiaire de cette connexion.

+

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.

-

Le constructeur WebSocket accepte deux paramètres, un paramètre obligatoire et un facultatif:

+

Pour construire un objet WebSocket, on utilisera le constructeur WebSocket().

-
WebSocket WebSocket(
-  in DOMString url,
-  in optional DOMString protocols
-);
+
{{AvailableInWorkers}}

 
-WebSocket WebSocket(
-  in DOMString url,
-  in optional DOMString[] protocols
-);
-
+

Constructeur

-
url
-
URL à laquelle se connecter; ce devrait être l'URL à laquelle le serveur WebSocket répondra.
-
protocols {{ optional_inline() }}
-
Une chaîne de caractères spécifiant un protocole, ou un tableau de chaîne de caractères (plusieurs protocoles). Ces chaînes sont utilisées pour indiquer les sous-protocoles, afin qu'un même serveur puisse implémenter de multiples sous-protocoles WebSocket (par exemple, vous pourriez souhaiter qu'un serveur soit capable de gérer différents types d'intéractions en fonction du protocole spécifié). Si vous ne passez aucune chaîne de caractères pour le(s) protocole(s), une chaîne vide est utilisée.
+
WebSocket(url[, protocols])
+
Renvoie un nouvel objet WebSocket.
-

Le constructeur peut lancer des exceptions:

- -
-
SECURITY_ERR
-
Le port vers lequel la connexion est tentée est actuellement bloqué.
-
- -
-
- -

Vue d'ensemble des méthodes

- - - - - - - - - - -
void close(in optional unsigned long code, in optional DOMString reason);
void send(in DOMString data);
- -

Attributs

+

Constantes

- - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AttributTypeDescriptionConstanteValeur
binaryType{{DOMXref("DOMString")}}Une chaîne de caractères indiquant le type de données binaires transmises par la connexion. Les valeurs possibles sont soit "blob" si des objets DOM {{ domxref("Blob") }} sont utilisés ou "arraybuffer" si des objets ArrayBuffer sont utilisés.
bufferedAmountunsigned longLe nombre d'octets de données mis en fil d'attente (n'étant pas encore transmis sur le réseau) en effectuant des appels à {{ manch("send") }}. Cette valeur n'est pas remise à zéro quand la connexion est fermée; elle continue d'augmenter si les appels à {{ manch("send") }} persistent. Lecture seule.
extensions{{DOMXref("DOMString")}}Extensions sélectionnées par le serveur. Actuellement, c'est une chaîne de caractères vide ou une liste des extensions telle que décidée par la connexion.
onclose{{DOMXref("EventListener")}}Un gestionnaire d'évènement à appeler quand la valeur de l'attribut readyState de la connexion WebSocket devient CLOSED. Le gestionnaire reçoit un évènement CloseEvent nommé "close".
onerror{{DOMXref("EventListener")}}Un gestionnaire d'évènement à appeler quand une erreur survient. L'évènement est un évènement de base, nommé "error".
onmessage{{DOMXref("EventListener")}}Un gestionnaire d'évènement à appeler quand un message émis par le serveur est reçu. Le gestionnaire reçoit un évènement MessageEvent nommé "message".
onopen{{DOMXref("EventListener")}}Un gestionnaire d'évènement à appeler quand la valeur de l'attribut readyState de la connexion WebSocket devient OPEN; cela indique que la connexion est prête à recevoir et émettre des données. L'évènement est un évènement de base nommé "open".
protocol{{DOMXref("DOMString")}}Une chaîne de caractères indiquant le nom du sous-protocole que le serveur a choisi; ce sera l'une des chaînes spécifiées dans le paramètre protocols lors de la création de l'objet WebSocket.
readyStateunsigned shortLe statut (actuel) de la connexion; c'est une  valeur de {{ anch("Constantes de statut") }}. Lecture Seule.
url{{DOMXref("DOMString")}}L'URL telle que déterminée par le constructeur. C'est toujours une URL absolue. Lecture Seule.
- -

Constantes

- -

Constantes de statut

- -

Ces constantes sont utilisées par l'attribut readyState pour décrire le statut de la connexion WebSocket.

- - - - - - - - - - + - - + - - + - - + -
ConstantValueDescription
CONNECTINGWebSocket.CONNECTING 0La connexion n'est pas encore établie.
OPENWebSocket.OPEN 1La connexion est établie et prête pour la communication.
CLOSINGWebSocket.CLOSING 2La connexion est en train de se fermer.
CLOSEDWebSocket.CLOSED 3La connexion est fermée ou n'a pas pu être établie.
-

Méthodes

- -

close()

- -

Ferme la connexion Websocket ou abandonne la tentative de connexion. Si la connexion est déjà fermée (statut CLOSED), cette méthode est sans effet.

- -
void close(
-  in optional unsigned short code,
-  in optional DOMString reason
-);
-
- -
Paramètres
+

Propriétés

-
code {{ optional_inline() }}
-
Une valeur numérique indiquant le code du statut décrivant pourquoi la connexion est fermée. Si ce paramètre n'est pas spécifié, une valeur par défaut de 1000 est utilisée (indiquant une fermeture standard de "transaction terminée"). Voir la liste des codes de statut sur la page de l'évènement CloseEvent pour les valeurs autorisées.
-
reason {{ optional_inline() }}
-
Une chaîne de caractère humainement-compréhensible expliquant pourquoi la connexion est fermée. Cette chaîne ne doit pas excéder 123 octets (et non pas caractères) de texte UTF-8.
+
WebSocket.binaryType
+
Le type de données binaire utilisé par la connexion.
+
WebSocket.bufferedAmount {{readonlyinline}}
+
Le nombre d'octets de données dans la queue.
+
WebSocket.extensions {{readonlyinline}}
+
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 {{readonlyinline}}
+
Le sous-protocole sélectionné par le serveur.
+
WebSocket.readyState {{readonlyinline}}
+
L'état courant de la connexion.
+
WebSocket.url {{readonlyinline}}
+
L'URL absolue de la WebSocket.
-
Exceptions lancées
+

Méthodes

-
INVALID_ACCESS_ERR
-
Un code invalide a été spécifié.
-
SYNTAX_ERR
-
La chaîne de caractères (paramètre reason) est trop longue ou contient des données invalides.
+
WebSocket.close([code[, reason]])
+
Ferme la connexion.
+
WebSocket.send(data)
+
Ajoute des données à transmettre à la queue.
-
Notes
- -

Concernant Gecko: Cette méthode ne supporte aucun paramètre avant Gecko 8.0 {{ geckoRelease("8.0") }}.

- -

send()

- -

Émet des données vers le serveur via la connexion WebSocket.

- -
void send(
-  in DOMString data
-);
-
-void send(
-  in ArrayBuffer data
-);
-
-void send(
-  in Blob data
-);
-
- -
Paramètres
+

Évènements

-
-
data
-
Une chaîne de caractères à envoyer au serveur.
-
- -
Exceptions lancées
+

Vous pouvez écouter ces évènements en utilisant la méthode addEventListener() ou en affectant un gestionnaire d'évènement à la propriété onnomevenement de cette interface.

-
INVALID_STATE_ERR
-
La connexion n'est pas actuellent ouverte (valeur de l'attribut readyState OPEN).
-
SYNTAX_ERR
-
La chaîne de caractères contient des données invalides.
+
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.
-
Remarques
- -
-

Note: L'implémentation de la méthode send() dans Gecko diffère quelques peu des spécifications dans {{Gecko("6.0")}}; Gecko retourne une valeur booléenne (boolean) indiquant si la connexion est toujours ouverte (et, par extension, que les données ont bien été mise en fil d'émission ou émises); cette différence est corrigée dans {{Gecko("8.0")}}.

- -

Sur {{Gecko("11.0")}}, le support d'ArrayBuffer est implémenté, mais pas le type de données {{ domxref("Blob") }}.

-
- -

Exemple

- -
var socket = null;
-try {
-    // Connexion vers un serveur HTTP
-    // prennant en charge le protocole WebSocket ("ws://").
-    socket = new WebSocket("ws://localhost");
-
-    // ----- OU -----
-
-    // Connexion vers un serveur HTTPS
-    // prennant en charge le protocole WebSocket over SSL ("wss://").
-    socket = new WebSocket("wss://localhost");
-} catch (exception) {
-    console.error(exception);
-}
-
-// Récupération des erreurs.
-// Si la connexion ne s'établie pas,
-// l'erreur sera émise ici.
-socket.onerror = function(error) {
-    console.error(error);
-};
+
Exemples

 
-// Lorsque la connexion est établie.
-socket.onopen = function(event) {
-    console.log("Connexion établie.");
+
// Créer une connexion WebSocket
+const socket = new WebSocket('ws://localhost:8080');
 
-    // Lorsque la connexion se termine.
-    this.onclose = function(event) {
-        console.log("Connexion terminé.");
-    };
+// La connexion est ouverte
+socket.addEventListener('open', function (event) {
+ socket.send('Coucou le serveur !');
+});
 
-    // Lorsque le serveur envoi un message.
-    this.onmessage = function(event) {
-        console.log("Message:", event.data);
-    };
+// Écouter les messages
+socket.addEventListener('message', function (event) {
+  console.log('Voici un message du serveur', event.data);
+});

 
-    // Envoi d'un message vers le serveur.
-    this.send("Hello world!");
-};
-
+

Spécifications

-

Specifications

- - - - - - - - - - - - - - -
SpecificationStatusComment
{{SpecName("Websockets", "#the-websocket-interface", "WebSocket")}}{{Spec2("Websockets")}}Definition initiale
+

{{Specifications}}

-

Compatibilité des navigateurs

+

Compatibilité des navigateurs

-

{{Compat("api.WebSocket")}}

+

{{Compat}}

-

Voir aussi

+

Voir aussi

diff --git a/files/fr/web/api/websocket/message_event/index.html b/files/fr/web/api/websocket/message_event/index.html new file mode 100644 index 0000000000..dc35ad18b2 --- /dev/null +++ b/files/fr/web/api/websocket/message_event/index.html @@ -0,0 +1,57 @@ +--- +title: 'WebSocket : évènement message' +slug: Web/API/WebSocket/message_event +browser-compat: api.WebSocket.message_event +--- +
{{APIRef}}
+ +

L'évènement message est déclenché lorsque des données sont reçues via une WebSocket.

+ + + + + + + + + + + + + + + + + + + + +
Bouillonne/RemonteNon
AnnulableNon
InterfaceMessageEvent
Propriété de gestionnaire d'évènement correspondanteonmessage
+ +

Exemples

+ +
+// Crée une connexion WebSocket
+const socket = new WebSocket('ws://localhost:8080');
+
+// Écoute les différents messages
+socket.addEventListener('message', function (event) {
+    console.log('Message reçu du serveur ', event.data);
+});
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

+ +

Voir aussi

+ + diff --git a/files/fr/web/api/websocket/onclose/index.html b/files/fr/web/api/websocket/onclose/index.html new file mode 100644 index 0000000000..040f03c485 --- /dev/null +++ b/files/fr/web/api/websocket/onclose/index.html @@ -0,0 +1,27 @@ +--- +title: WebSocket.onclose +slug: Web/API/WebSocket/onclose +browser-compat: api.WebSocket.onclose +--- +

{{APIRef("Web Sockets API")}}

+ +

La propriété WebSocket.onclose est un gestionnaire d'évènement invoqué lorsque l'état readyState de la connexion WebSocket change de valeur pour passer à CLOSED. Ce gestionnaire est appelé avec un paramètre CloseEvent.

+ +

Syntaxe

+ +
+unWebSocket.onclose = function(event) {
+  console.log("La WebSocket est désormais fermée.");
+};
+ +

Valeur

+ +

Une fonction EventListener.

+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/onerror/index.html b/files/fr/web/api/websocket/onerror/index.html new file mode 100644 index 0000000000..5ffafd26cd --- /dev/null +++ b/files/fr/web/api/websocket/onerror/index.html @@ -0,0 +1,35 @@ +--- +title: WebSocket.onerror +slug: Web/API/WebSocket/onerror +browser-compat: api.WebSocket.onerror +--- +
{{APIRef("Web Sockets API")}}
+ +

La propriété onerror de l'interface WebSocket est un gestionnaire d'évènement qui est appelé lorsqu'une erreur se produit sur la connexion WebSocket.

+ +

Il est également possible d'ajouter un gestionnaire d'évènement error avec la méthode addEventListener().

+ +

Syntaxe

+ +
+webSocket.onerror = eventHandler;
+
+ +

Valeur

+ +

Une fonction ou un gestionnaire d'évènement qui est exécuté lorsqu'un évènement error se produit sur la connexion WebSocket.

+ +

Exemple

+ +
+webSocket.onerror = function(event) {
+  console.error("Erreur WebSocket observée :", event);
+};
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/onmessage/index.html b/files/fr/web/api/websocket/onmessage/index.html new file mode 100644 index 0000000000..03ff9451fb --- /dev/null +++ b/files/fr/web/api/websocket/onmessage/index.html @@ -0,0 +1,27 @@ +--- +title: WebSocket.onmessage +slug: Web/API/WebSocket/onmessage +browser-compat: api.WebSocket.onmessage +--- +
{{APIRef("Web Sockets API")}}
+ +

La propriété WebSocket.onmessage est un gestionnaire d'évènement qui est appelé lorsqu'un message est reçu depuis le serveur. Ce gestionnaire est appelé avec un évènement MessageEvent en paramètre.

+ +

Syntaxe

+ +
+unWebSocket.onmessage = function(event) {
+  console.debug("Message WebSocket reçu :", event);
+};
+ +

Valeur

+ +

Un objet EventListener.

+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/onopen/index.html b/files/fr/web/api/websocket/onopen/index.html new file mode 100644 index 0000000000..488b3eb0be --- /dev/null +++ b/files/fr/web/api/websocket/onopen/index.html @@ -0,0 +1,27 @@ +--- +title: WebSocket.onopen +slug: Web/API/WebSocket/onopen +browser-compat: api.WebSocket.onopen +--- +
{{APIRef("Web Sockets API")}}
+ +

La propriété WebSocket.onopen est un gestionnaire d'évènement qui est appelé lorsque l'état (readyState) de la connexion WebSocket passe à 1, indiquant que la connexion est prête pour l'envoi et la réception de données. Lorsqu'il est appelé, ce gestionnaire d'évènement reçoit un objet Event en paramètre.

+ +

Syntaxe

+ +
+uneWebSocket.onopen = function(event) {
+  console.log("La WebSocket est désormais ouverte.");
+};
+ +

Valeur

+ +

Un objet EventListener.

+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/open_event/index.html b/files/fr/web/api/websocket/open_event/index.html new file mode 100644 index 0000000000..cfa28af7bb --- /dev/null +++ b/files/fr/web/api/websocket/open_event/index.html @@ -0,0 +1,57 @@ +--- +title: 'WebSocket : évènement open' +slug: Web/API/WebSocket/open_event +browser-compat: api.WebSocket.open_event +--- +
{{APIRef}}
+ +

L'évènement open est déclenché lorsqu'une connexion avec une WebSocket est ouverte.

+ + + + + + + + + + + + + + + + + + + + +
Bouillonne/RemonteNon
AnnulableNon
InterfaceEvent
Propriété de gestionnaire d'évènement correspondanteonopen
+ +

Exemples

+ +
+// Crée une connexion WebSocket
+const socket = new WebSocket('ws://localhost:8080');
+
+// La connexion est ouverte
+socket.addEventListener('open', (event) => {
+  socket.send('Coucou serveur !');
+});
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

+ +

Voir aussi

+ + diff --git a/files/fr/web/api/websocket/protocol/index.html b/files/fr/web/api/websocket/protocol/index.html new file mode 100644 index 0000000000..cf2bc5d053 --- /dev/null +++ b/files/fr/web/api/websocket/protocol/index.html @@ -0,0 +1,26 @@ +--- +title: WebSocket.protocol +slug: Web/API/WebSocket/protocol +browser-compat: api.WebSocket.protocol +--- +

{{APIRef("Web Sockets API")}}

+ +

La propriété en lecture seule WebSocket.protocol renvoie le nom du sous protocole sélectionné par le serveur. Cette valeur sera l'une des chaînes de caractères du paramètre protocols utilisé lors de la création de l'objet WebSocket ou la chaîne vide si aucune connexion n'est établie.

+ +

Syntax

+ +
+var protocol = uneWebSocket.protocol;
+
+ +

Valeur

+ +

Une chaîne de caractères DOMString.

+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/readystate/index.html b/files/fr/web/api/websocket/readystate/index.html new file mode 100644 index 0000000000..d33114d5f5 --- /dev/null +++ b/files/fr/web/api/websocket/readystate/index.html @@ -0,0 +1,56 @@ +--- +title: WebSocket.readyState +slug: Web/API/WebSocket/readyState +browser-compat: api.WebSocket.readyState +--- +

{{APIRef("Web Sockets API")}}

+ +

La propriété en lecture seule WebSocket.readyState renvoie l'état courant de la connexion WebSocket.

+ +

Syntaxe

+ +
+var readyState = uneWebSocket.readyState;
+
+ +

Valeur

+ +

Cette propriété peut valoir l'une des valeurs de type unsigned short suivantes :

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValeurÉtatDescription
0CONNECTINGLa socket a été créée. La connexion n'est pas encore ouverte.
1OPENLa connexion est ouverte et prête pour la communication.
2CLOSINGLa connexion est en cours de fermeture.
3CLOSEDLa connexion est fermée ou n'a pas pu être ouverte.
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/send/index.html b/files/fr/web/api/websocket/send/index.html new file mode 100644 index 0000000000..62cd149882 --- /dev/null +++ b/files/fr/web/api/websocket/send/index.html @@ -0,0 +1,55 @@ +--- +title: WebSocket.send() +slug: Web/API/WebSocket/send +browser-compat: api.WebSocket.send +--- +

{{APIRef("Web Sockets API")}}

+ +

La méthode WebSocket.send() rajoute les données indiquées à la queue pour transmission au serveur via la connexion WebSocket, augmentant ainsi la valeur de bufferedAmount du nombre d'octets nécessaires pour les données. Si les données ne peuvent être envoyées (par exemple parce qu'elles doivent être mises en tampon mais que la mémoire tampon est pleine), la socket est fermée automatiquement.

+ +

Syntaxe

+ +
+WebSocket.send("Coucou serveur !");
+
+ +

Paramètres

+ +
+
data
+
Les données à envoyer au serveur. La valeur peut avoir un des types suivants : +
+
USVString
+
Une chaîne de caractères. Cette chaîne est ajoutée au tampon au format UTF-8 et la valeur de bufferedAmount est augmentée du nombre d'octets nécessaires pour représenter cette chaîne de caractères UTF-8.
+
ArrayBuffer
+
Les données binaires peuvent aussi être envoyées avec un tableau typé. Son contenu binaire est mis en tampon et la valeur de bufferedAmount est augmentée du nombre d'octets nécessaires.
+
Blob
+
Lorsqu'une valeur Blob est fournie, les données brutes du blob sont rajoutées à la queue pour être transmises dans une frame binaire. La valeur de bufferedAmount est augmentée du nombre d'octets utilisés pour représenter ces données brutes.
+
ArrayBufferView
+
Il est possible d'envoyer n'importe quel objet étant un tableau typé JavaScript sous la forme d'une frame binaire. Le contenu des données binaires est rajouté à la queue dans le tampon et la valeur de bufferedAmount est augmentée du nombre d'octets correspondant.
+
+
+
+ +

Exceptions levées

+ +
+
INVALID_STATE_ERR
+
La connexion n'est pas ouverte actuellement.
+
SYNTAX_ERR
+
Les données sont une chaîne de caractères pour laquelle il existe des surrogates non appairés.
+
+ +
+

Note : Pour Gecko 6.0, l'implémentation de send() varie de la spécification : le moteur renvoie un booléen indiquant si la connexion est toujours ouverte (par extension, cela indique si les données ont été correctement rajoutées à la queue ou transmises). Ce comportement a été corrigé avec Gecko 8.0.

+ +

Avec Gecko 11.0, la prise en charge des ArrayBuffer est implémentée mais pas celle pour les objets Blob.

+
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/url/index.html b/files/fr/web/api/websocket/url/index.html new file mode 100644 index 0000000000..acaa13de14 --- /dev/null +++ b/files/fr/web/api/websocket/url/index.html @@ -0,0 +1,26 @@ +--- +title: WebSocket.url +slug: Web/API/WebSocket/url +browser-compat: api.WebSocket.url +--- +

{{APIRef("Web Sockets API")}}

+ +

La propriété en lecture seule WebSocket.url renvoie l'URL absolue de la WebSocket telle que résolue par le constructeur.

+ +

Syntaxe

+ +
+var url = aWebSocket.url;
+
+ +

Valeur

+ +

Une chaîne de caractères DOMString.

+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

diff --git a/files/fr/web/api/websocket/websocket/index.html b/files/fr/web/api/websocket/websocket/index.html new file mode 100644 index 0000000000..955611fa20 --- /dev/null +++ b/files/fr/web/api/websocket/websocket/index.html @@ -0,0 +1,42 @@ +--- +title: WebSocket() +slug: Web/API/WebSocket/WebSocket +browser-compat: api.WebSocket.WebSocket +--- +

{{APIRef("Web Sockets API")}}

+ +

Le constructeur WebSocket() renvoie un nouvel objet WebSocket.

+ +

Syntaxe

+ +
+var aWebSocket = new WebSocket(url [, protocols]);
+
+ +

Paramètres

+ +
+
url
+
L'URL à laquelle se connecter. Cela devrait être l'URL à laquelle le serveur WebSocket répondra.
+
protocols {{optional_inline}}
+
Une valeur qui est une chaîne de caractères représentant un seul protocole ou un tableau de chaînes de caractères représentant une liste de protocoles. Ces chaînes de caractères indiquent des sous-protocoles : un serveur donné pourra implémenter différents sous-protocoles WebSocket (on peut vouloir qu'un serveur soit capable de gérér différents types d'interaction selon le protocol indiqué). +
+
Si cette valeur est absence, c'est un tableau vide qui est utilisé par défaut : [].
+
+ +

Exceptions levées

+ +
+
SECURITY_ERR
+
Le port ciblé par la tentative de connexion est bloqué.
+
SyntaxError
+
L'URL est invalide.
+
+ +

Spécifications

+ +

{{Specifications}}

+ +

Compatibilité des navigateurs

+ +

{{Compat}}

-- cgit v1.2.3-54-g00ecf