blob: 45acf344a346e1cb1c26bd94e72cfe2e4041c142 (
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
|
---
title: WebSocket
slug: Web/API/WebSocket
browser-compat: api.WebSocket
translation_of: Web/API/WebSocket
---
<div>{{APIRef("Web Sockets API")}}</div>
<p>L'objet <code>WebSocket</code> fournit l'API qui permet de créer et de gérer une connexion <a href="/fr/docs/Web/API/WebSockets_API">WebSocket</a> à un serveur ainsi que d'envoyer et de recevoir des données sur cette connexion.</p>
<p>Pour construire un objet <code>WebSocket</code>, on utilisera le constructeur <code><a href="/fr/docs/Web/API/WebSocket/WebSocket">WebSocket()</a></code>.</p>
<p>{{AvailableInWorkers}}</p>
<h2 id="constructor">Constructeur</h2>
<dl>
<dt><a href="/fr/docs/Web/API/WebSocket/WebSocket"><code>WebSocket(url[, protocols])</code></a></dt>
<dd>Renvoie un nouvel objet <code>WebSocket</code>.</dd>
</dl>
<h2 id="constants">Constantes</h2>
<table class="standard-table">
<tbody>
<tr>
<td class="header">Constante</td>
<td class="header">Valeur</td>
</tr>
<tr>
<td><code>WebSocket.CONNECTING</code></td>
<td><code>0</code></td>
</tr>
<tr>
<td><code>WebSocket.OPEN</code></td>
<td><code>1</code></td>
</tr>
<tr>
<td><code>WebSocket.CLOSING</code></td>
<td><code>2</code></td>
</tr>
<tr>
<td><code>WebSocket.CLOSED</code></td>
<td><code>3</code></td>
</tr>
</tbody>
</table>
<h2 id="properties">Propriétés</h2>
<dl>
<dt><a href="/fr/docs/Web/API/WebSocket/binaryType"><code>WebSocket.binaryType</code></a></dt>
<dd>Le type de données binaire utilisé par la connexion.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/bufferedAmount"><code>WebSocket.bufferedAmount</code></a> {{readonlyinline}}</dt>
<dd>Le nombre d'octets de données dans la queue.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/extensions"><code>WebSocket.extensions</code></a> {{readonlyinline}}</dt>
<dd>Les extensions sélectionnées par le serveur.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/onclose"><code>WebSocket.onclose</code></a></dt>
<dd>Un gestionnaire d'évènement à appeler lorsque la connexion est fermée.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/onerror"><code>WebSocket.onerror</code></a></dt>
<dd>Un gestionnaire d'évènement à appeler en cas d'erreur.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/onmessage"><code>WebSocket.onmessage</code></a></dt>
<dd>Un gestionnaire d'évènement à appeler lors de la réception d'un message du serveur.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/onopen"><code>WebSocket.onopen</code></a></dt>
<dd>Un gestionnaire d'évènement à appeler lorsque la connexion est ouverte.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/protocol"><code>WebSocket.protocol</code></a> {{readonlyinline}}</dt>
<dd>Le sous-protocole sélectionné par le serveur.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/readyState"><code>WebSocket.readyState</code></a> {{readonlyinline}}</dt>
<dd>L'état courant de la connexion.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/url"><code>WebSocket.url</code></a> {{readonlyinline}}</dt>
<dd>L'URL absolue de la WebSocket.</dd>
</dl>
<h2 id="methods">Méthodes</h2>
<dl>
<dt><a href="/fr/docs/Web/API/WebSocket/close"><code>WebSocket.close([code[, reason]])</code></a></dt>
<dd>Ferme la connexion.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/send"><code>WebSocket.send(data)</code></a></dt>
<dd>Ajoute des données à transmettre à la queue.</dd>
</dl>
<h2 id="events">Évènements</h2>
<p>Vous pouvez écouter ces évènements en utilisant la méthode <code>addEventListener()</code> ou en affectant un gestionnaire d'évènement à la propriété <code>on<em>nomevenement</em></code> de cette interface.</p>
<dl>
<dt><a href="/fr/docs/Web/API/WebSocket/close_event"><code>close</code></a></dt>
<dd>Déclenché lorsqu'une connexion avec une <code>WebSocket</code> est fermée. Également disponible avec la propriété <a href="/fr/docs/Web/API/WebSocket/onclose"><code>onclose</code></a>.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/error_event"><code>error</code></a></dt>
<dd>Déclenché lorsqu'une connexion avec une <code>WebSocket</code> 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é <a href="/fr/docs/Web/API/WebSocket/onerror"><code>onerror</code></a>.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/message_event"><code>message</code></a></dt>
<dd>Déclenché lorsque des données sont reçues via une <code>WebSocket</code>. Également disponible avec la propriété <a href="/fr/docs/Web/API/WebSocket/onmessage"><code>onmessage</code></a>.</dd>
<dt><a href="/fr/docs/Web/API/WebSocket/open_event"><code>open</code></a></dt>
<dd>Déclenché lorsqu'une connexion avec une <code>WebSocket</code> est ouverte. Également disponible avec la propriété <a href="/fr/docs/Web/API/WebSocket/onopen"><code>onopen</code></a>.</dd>
</dl>
<h2 id="examples">Exemples</h2>
<pre class="brush: js">// Créer une connexion WebSocket
const socket = new WebSocket('ws://localhost:8080');
// La connexion est ouverte
socket.addEventListener('open', function (event) {
socket.send('Coucou le serveur !');
});
// Écouter les messages
socket.addEventListener('message', function (event) {
console.log('Voici un message du serveur', event.data);
});</pre>
<h2 id="specifications">Spécifications</h2>
<p>{{Specifications}}</p>
<h2 id="browser_compatibility">Compatibilité des navigateurs</h2>
<p>{{Compat}}</p>
<h2 id="see_also">Voir aussi</h2>
<ul>
<li><a href="/fr/docs/Web/API/WebSockets_API/Writing_WebSocket_client_applications">Écrire des applications clientes WebSocket</a></li>
</ul>
|
