aboutsummaryrefslogtreecommitdiff
path: root/files/fr/web/api/closeevent/index.md
blob: e128b97ef508e27301ea2fe4f460195280545594 (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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
---
title: CloseEvent
slug: Web/API/CloseEvent
tags:
  - API
  - Interface
  - Reference
  - Web
  - WebSocket
translation_of: Web/API/CloseEvent
---
{{APIRef("Websockets API")}}

Un évènement `CloseEvent` est envoyé au client utilisant une [WebSocket](/fr/docs/Glossary/WebSockets) lorsque la connexion est fermée. Cet évènement est envoyé au `listener` indiqué par l'attribut `onclose` de la `WebSocket`.

## Constructeur

- {{domxref("CloseEvent.CloseEvent", "CloseEvent()")}}
  - : Construit un nouvel événement `CloseEvent`.

## Propriétés

_Cette interface hérite également des propriétés de sa mère, {{domxref("Event")}}._

- {{domxref("CloseEvent.code")}} {{readOnlyInline}}

  - : Retourne un `unsigned short` contenant le code de fermeture envoyé par le serveur. Les valeurs possibles sont données ci-dessous.

    <table class="standard-table">
      <tbody>
        <tr>
          <td class="header">Status code</td>
          <td class="header">Nom</td>
          <td class="header">Description</td>
        </tr>
        <tr>
          <td><code>0</code>–<code>999</code></td>
          <td></td>
          <td><strong>Reservé et inutilisé.</strong></td>
        </tr>
        <tr>
          <td><code>1000</code></td>
          <td><code>CLOSE_NORMAL</code></td>
          <td>Fermeture normale ; la connexion s'est terminée normalement.</td>
        </tr>
        <tr>
          <td><code>1001</code></td>
          <td><code>CLOSE_GOING_AWAY</code></td>
          <td>
            <p>
              Reçu lorsque une erreur est apparue sur le serveur ou le navigateur
              quitte la page ayant ouvert la connexion.
            </p>
          </td>
        </tr>
        <tr>
          <td><code>1002</code></td>
          <td><code>CLOSE_PROTOCOL_ERROR</code></td>
          <td>
            L'autre partie de la connexion termine la connexion à cause d'une erreur
            de protocole.
          </td>
        </tr>
        <tr>
          <td><code>1003</code></td>
          <td><code>CLOSE_UNSUPPORTED</code></td>
          <td>
            La connexion est terminée car le serveur à reçu des données d'un type
            qu'il ne peut pas accepter (par exemple des données binaire plutôt que
            du texte).
          </td>
        </tr>
        <tr>
          <td><code>1004</code></td>
          <td></td>
          <td>
            <strong>Réservé.</strong> Une utilisation pourrait être définie dans le
            futur.
          </td>
        </tr>
        <tr>
          <td><code>1005</code></td>
          <td><code>CLOSE_NO_STATUS</code></td>
          <td>
            <strong>Réservé.</strong> Indique qu'aucun code n'est donné bien qu'un
            code était attendu.
          </td>
        </tr>
        <tr>
          <td><code>1006</code></td>
          <td><code>CLOSE_ABNORMAL</code></td>
          <td>
            <strong>Réservé.</strong> Utilisé pour indiquer que la connexion a été
            terminée anormalement (sans paquet indiquant la fermeture).
          </td>
        </tr>
        <tr>
          <td><code>1007</code></td>
          <td></td>
          <td>
            Le serveur termine la connexion car un message contenant des données
            incohérentes a été reçu (e.g., des données qui ne sont pas au format
            UTF-8 dans un message texte).
          </td>
        </tr>
        <tr>
          <td><code>1008</code></td>
          <td></td>
          <td>
            Le serveur termine la connexion car un message ne respectant pas la
            politique du serveur est reçu. C'est un code d'état générique qui est
            utilisé lorsque les codes 1003 et 1009 ne correspondent pas à la
            situation.
          </td>
        </tr>
        <tr>
          <td><code>1009</code></td>
          <td><code>CLOSE_TOO_LARGE</code></td>
          <td>
            Le serveur termine la connexion car les données reçues sont trop
            grosses.
          </td>
        </tr>
        <tr>
          <td><code>1010</code></td>
          <td></td>
          <td>
            Le client termine la connexion car il souhaitait négocier une ou
            plusieurs extensions mais le serveur ne l'a pas fait.
          </td>
        </tr>
        <tr>
          <td><code>1011</code></td>
          <td></td>
          <td>
            Le serveur termine la connexion car il a rencontré un problème qui
            l'empêche de traiter la requête.
          </td>
        </tr>
        <tr>
          <td>–<code>1014</code></td>
          <td></td>
          <td>
            <strong
              >Réservé pour une utilisation future par le standard
              WebSocket.</strong
            >
          </td>
        </tr>
        <tr>
          <td><code>1015</code></td>
          <td></td>
          <td>
            <strong>Réservé.</strong> Indique que la connexion a été fermée à cause
            d'une erreur durant le handshake TLS (e.g., le certificat du serveur ne
            peut pas être vérifié).
          </td>
        </tr>
        <tr>
          <td><code>1016</code>–<code>1999</code></td>
          <td></td>
          <td>
            <strong
              >Réservé pour une utilisation future par le standard
              WebSocket.</strong
            >
          </td>
        </tr>
        <tr>
          <td><code>2000</code>–<code>2999</code></td>
          <td></td>
          <td>
            <strong
              >Réservé pour une utilisation future par le standard
              WebSocket.</strong
            >
          </td>
        </tr>
        <tr>
          <td><code>3000</code>–<code>3999</code></td>
          <td></td>
          <td>
            Disponible pour être utilisé par des bibliothèques ou des frameworks.
            Ces codes <strong>ne doivent pas</strong> être utilisés par des
            applications.
          </td>
        </tr>
        <tr>
          <td><code>4000</code>–<code>4999</code></td>
          <td></td>
          <td>Disponible pour être utilisés par des applications.</td>
        </tr>
      </tbody>
    </table>

- {{domxref("CloseEvent.reason")}} {{readOnlyInline}}
  - : Retourne un {{ domxref("DOMString") }} qui indique la raison pour laquelle le serveur a fermé la connexion. Ce message est spécifique au serveur et au sous-protocole utilisé.
- {{domxref("CloseEvent.wasClean")}} {{readOnlyInline}}
  - : Retourne un {{jsxref("Boolean")}} qui indique si la connexion a été correctement fermée ou non.

## Méthodes

_Cette interface hérite également des propriétés de sa mère, {{domxref("Event")}}._

- {{domxref("CloseEvent.initCloseEvent()")}} {{Non-standard_inline}} {{Obsolete_inline}}
  - : Initialise la valeur d'un `CloseEvent`. Si l'événement a déjà été envoyé, cette méthode ne fait rien.

## Spécifications

| Spécification                                                                                                        | Statut                               | Commentaire          |
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -------------------- |
| {{ SpecName('HTML WHATWG', 'web-sockets.html#the-closeevent-interface', 'CloseEvent') }} | {{ Spec2('HTML WHATWG') }} | Définition initiale. |

## Compatibilité des navigateurs

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

## Voir aussi

- {{domxref("WebSocket")}}