aboutsummaryrefslogtreecommitdiff
path: root/files/fr/web/api/websocket/close/index.html
blob: 09621ca71b7785537a168aa76f39b8bf83a09cb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
---
title: WebSocket.close()
slug: Web/API/WebSocket/close
browser-compat: api.WebSocket.close
---
<p>{{APIRef("Web Sockets API")}}</p>

<p>La méthode <strong><code>WebSocket.close()</code></strong> ferme la connexion <a href="/fr/docs/Web/API/WebSocket"><code>WebSocket</code></a> ou interrompt l'éventuelle tentative de connexion. Si la connexion est déjà fermée (état <code>CLOSED</code>), cette méthode ne fait rien.</p>

<h2 id="syntax">Syntaxe</h2>

<pre class="brush: js">WebSocket.close();</pre>
<pre class="brush: js">WebSocket.close(code);</pre>
<pre class="brush: js">WebSocket.close(reason);</pre>
<pre class="brush: js">WebSocket.close(code, reason);</pre>

<h3 id="parameters">Paramètres</h3>

<dl>
  <dt><code>code</code> {{optional_inline}}</dt>
  <dd>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 <a href="/fr/docs/Web/API/CloseEvent#status_codes">la liste des codes de statut</a> de <a href="/fr/docs/Web/API/CloseEvent"><code>CloseEvent</code></a> pour les valeurs autorisées.</dd>
  <dt><code>reason</code> {{optional_inline}}</dt>
  <dd>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, <strong>cela ne signifie pas</strong> 123 caractères).</dd>
</dl>

<h3 id="exceptions_thrown">Exceptions levées</h3>

<dl>
  <dt><code>INVALID_ACCESS_ERR</code></dt>
  <dd>Un code invalide a été fourni avec <code>code</code>.</dd>
  <dt><code>SYNTAX_ERR</code></dt>
  <dd>La chaîne de caractères pour <code>reason</code> est trop longue ou contient des <i lang="en">surrogates</i> non appairés.</dd>
</dl>

<div class="note">
  <p><strong>Note :</strong> Avant Gecko 8.0, cette méthode ne prenait en charge aucun paramètre.</p>
</div>

<h2 id="specifications">Spécifications</h2>

<p>{{Specifications}}</p>

<h2 id="browser_compatibility">Compatibilité des navigateurs</h2>

<p>{{Compat}}</p>