From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- files/fr/web/api/websocket/close_event/index.html | 72 +++++ files/fr/web/api/websocket/index.html | 374 ++++++++++++++++++++++ 2 files changed, 446 insertions(+) create mode 100644 files/fr/web/api/websocket/close_event/index.html create mode 100644 files/fr/web/api/websocket/index.html (limited to 'files/fr/web/api/websocket') diff --git a/files/fr/web/api/websocket/close_event/index.html b/files/fr/web/api/websocket/close_event/index.html new file mode 100644 index 0000000000..f1ed8b2ff0 --- /dev/null +++ b/files/fr/web/api/websocket/close_event/index.html @@ -0,0 +1,72 @@ +--- +title: close +slug: Web/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.

+ +

Informations générales

+ +
+
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).
type {{readonlyInline}}{{domxref("DOMString")}}The type of event.
bubbles {{readonlyInline}}{{jsxref("Boolean")}}Whether the event normally bubbles or not.
cancelable {{readonlyInline}}{{jsxref("Boolean")}}Whether the event is cancellable or not.
+ +

Evénements liés

+ + + +

Voir aussi

+ + diff --git a/files/fr/web/api/websocket/index.html b/files/fr/web/api/websocket/index.html new file mode 100644 index 0000000000..61d34d0086 --- /dev/null +++ b/files/fr/web/api/websocket/index.html @@ -0,0 +1,374 @@ +--- +title: WebSocket +slug: Web/API/WebSocket +tags: + - API + - WebSocket + - WebSockets +translation_of: Web/API/WebSocket +--- +

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

+ +

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.

+ +

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

+ +
WebSocket WebSocket(
+  in DOMString url,
+  in optional DOMString protocols
+);
+
+WebSocket WebSocket(
+  in DOMString url,
+  in optional DOMString[] protocols
+);
+
+ +
+
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.
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributTypeDescription
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
CONNECTING0La connexion n'est pas encore établie.
OPEN1La connexion est établie et prête pour la communication.
CLOSING2La connexion est en train de se fermer.
CLOSED3La 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
+ +
+
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.
+
+ +
Exceptions lancées
+ +
+
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.
+
+ +
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
+ +
+
data
+
Une chaîne de caractères à envoyer au serveur.
+
+ +
Exceptions lancées
+ +
+
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.
+
+ +
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);
+};
+
+// Lorsque la connexion est établie.
+socket.onopen = function(event) {
+    console.log("Connexion établie.");
+
+    // Lorsque la connexion se termine.
+    this.onclose = function(event) {
+        console.log("Connexion terminé.");
+    };
+
+    // Lorsque le serveur envoi un message.
+    this.onmessage = function(event) {
+        console.log("Message:", event.data);
+    };
+
+    // Envoi d'un message vers le serveur.
+    this.send("Hello world!");
+};
+
+ +

Specifications

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

Voir aussi

+ + + +

Compatibilité des navigateurs

+ +

{{ CompatibilityTable() }}

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FonctionnalitéChromeFirefox (Gecko)Internet ExplorerOperaSafari
Support basique{{ CompatVersionUnknown() }}{{ CompatGeckoDesktop("2.0") }}{{ CompatVersionUnknown() }}{{ CompatVersionUnknown() }}{{ CompatUnknown() }}
Support des sous-protocoles{{ CompatUnknown() }}{{ CompatGeckoDesktop("6.0") }}{{ CompatUnknown() }}{{ CompatUnknown() }}{{ CompatUnknown() }}
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FonctionnalitéAndroidFirefox Mobile (Gecko)IE MobileOpera MobileSafari Mobile
Support basique{{ CompatUnknown() }}{{ CompatGeckoMobile("7.0") }}{{ CompatUnknown() }}{{ CompatUnknown() }}{{ CompatUnknown() }}
Support des sous-protocoles{{ CompatUnknown() }}{{ CompatGeckoMobile("7.0") }}{{ CompatUnknown() }}{{ CompatUnknown() }}{{ CompatUnknown() }}
+
+ +

Notes pour Gecko

+ +

Avec Gecko 6.0, le constructeur est préfixé; il vous faudra utiliser MozWebSocket():

+ +
var socket = new MozWebSocket("ws://www.example.com/socketserver");
+
+ +

L'attribut extensions n'est pas supporté par Gecko avant Gecko 8.0.

+ +
Note: Avant {{Gecko("11.0")}}, les messages (sur le point d'être émis) envoyés avec la méthode {{ manch("send") }} étaient limités à 16 Mo. Leur taille peut maintenant atteindre 2 Go.
+ +

{{ languages ( {"zh-tw": "zh_tw/WebSockets/WebSockets_reference/WebSocket"} ) }}

-- cgit v1.2.3-54-g00ecf