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
|
---
title: API TCP Socket
slug: Web/API/TCP_Socket_API
translation_of: Archive/B2G_OS/API/TPC_Socket_API
---
<p>{{DefaultAPISidebar("TCP Socket API")}}</p>
<p>{{ non-standard_header() }}</p>
<p>{{ B2GOnlyHeader2('privileged') }}</p>
<h2 id="Résumé">Résumé</h2>
<p>L'API TCPSocket se propose d'ouvrir et d'utiliser une connexion TCP. Cela permet de mettre en œuvre des protocoles de la couche supérieure à TCP comme IMAP, IRC, POP, HTTP, etc., ou même d'en créer de nouveaux pour des besoins spécifiques.</p>
<h2 id="Permission">Permission</h2>
<p>Pour utiliser cette API, comme pour toutes les API privilégiées, il est nécessaire de demander l'autorisation de l'utiliser dans l'application <a href="/fr/Apps/Manifeste" title="/fr/docs/Web/Apps/Manifest">app manifeste</a>.</p>
<pre class="brush: json">"permissions" : {
"tcp-socket" : {
"description" : "Create TCP sockets and communicate over them."
}
}</pre>
<h2 id="Aperçu">Aperçu</h2>
<p>Cette API est disponible à travers la propriété {{domxref("Navigator.mozTCPSocket","mozTCPSocket")}} qui est elle-même un objet {{domxref("TCPSocket")}}.</p>
<h3 id="Ouverture_d'un_socket">Ouverture d'un socket</h3>
<p>L'ouverture d'un socket est fait avec la méthode {{domxref("TCPSocket.open()")}}. Cette méthode peut avoir jusqu'à trois paramètres:</p>
<ol>
<li>Une chaîne représentant le nom du serveur auquel se connecter (il peut aussi être son adresse IP brute).</li>
<li>Un nombre représentant le port TCP à utiliser par la socket (certains protocoles ont un port standard, par exemple 80 pour HTTP, 447 pour SSL, 25 pour SMTP, etc. Les numéros de port au-delà de 1024 ne sont pas assignés à un protocole spécifique et peuvent être utilisés pour d'autres fins.)</li>
<li>Un objet optionnel contenant jusqu'à deux paramétres : un booléen nommé <code>useSecureTransport</code>, <code>false</code> par défaut, est nécessaire pour utiliser SSL, ; et une chaîne nommée <code>binaryType</code> permet d'indiquer le type de données récupérées par l'application à travers l'événement {{event("data")}}, avec les valeurs attendues <code>string</code> par défaut ou <code>arraybuffer</code>.</li>
</ol>
<pre class="brush: js">var socket = navigator.mozTCPSocket.open('localhost', 80);</pre>
<div class="note">
<p><strong>Note: </strong> Seulement les applications certifiées peuvent utiliser un port inférieur à 1024.</p>
</div>
<h3 id="Ecoute_des_connexions">Ecoute des connexions</h3>
<p>L'écoute des connexions se fait avec les méthodes {{domxref("TCPSocket.listen()")}}. Cette méthode prévoit jusqu'à trois paramètres:</p>
<ol>
<li>Un nombre représentant le port TCP à utiliser pour écouter les connexions.</li>
<li>Un objet facultatif spécifiant les détails de la réception. Cet objet attend une propriété appelée <code>binaryType</code>, qui est une chaîne qui peut avoir deux valeurs possibles: "string" ou "ArrayBuffer". Si la valeur est "ArrayBuffer" alors le {{domxref("TCPSocket.send()")}} utilise {{domxref("ArrayBuffer")}} et les données reçues seront également disponible dans ce format.</li>
<li>Un nombre représentant la longueur maximale de la file d'attente des connexions en attente.</li>
</ol>
<pre class="brush: js">var socket = navigator.mozTCPSocket.listen(8080);</pre>
<div class="note">
<p><strong>Note: </strong> Seulement applications certifiées peuvent écouter sur un port inférieur à 1024.</p>
</div>
<h3 id="Envoi_de_données">Envoi de données</h3>
<p>L'envoi de données se fait en utilisant la méthode {{domxref("TCPSocket.send()")}}. Les données envoyées peuvent au format chaîne ou <code><a href="/fr/docs/JavaScript/Typed_arrays/Uint8Array" title="/fr/docs/JavaScript/Typed_arrays/Uint8Array">Uint8Array</a></code>; Cependant, rappelez-vous qu'un socket TCP travail avec les données binaires. Pour cette raison, il est beaucoup plus sûr d'utiliser <code><a href="/fr/docs/JavaScript/Typed_arrays/Uint8Array" title="/fr/docs/JavaScript/Typed_arrays/Uint8Array">Uint8Array</a></code> à la place d'une chaîne lors de l'envoi des données.</p>
<p>Pout protocole TCP, il vaut mieux envoyer 64 Ko maximum de données en même temps. Quand moins de 64kb ont été tamponnés, un appel à la méthode {{domxref("TCPSocket.send()","send")}} retourne <code>true</code>. Si le tampon est plein, la méthode renverra <code>false</code> pour indiquer que l'application devra faire une pause pour vider le tampon. Chaque fois que le tampon est vidé, un événement {{event("drain")}} est déclenché et l'application peut reprendre envoi de données.</p>
<p>Il est possible de connaître exactement la quantité de données en mémoire tampon avec la propriété {{domxref("TCPSocket.bufferedAmount")}} .</p>
<pre class="brush: js">function getData() {
var data;
// récupérer les données
return data;
}
function pushData() {
var data;
do {
data = getData();
} while (data != null && socket.send(data));
}
// Chaque fois que le tampon est vidé
// Nous essayons à nouveau d'envoyer des données.
socket.ondrain = pushData;
// Lancer l'envoi de données.
pushData();
</pre>
<h3 id="Recevoir_les_données">Recevoir les données</h3>
<p>Chaque fois que le socket reçoit des données de l'hôte, il déclenche un événement {{event("data")}}. Cet événement donnera accès aux données du socket. Le type de données dépend de l'ensemble des options définies lorsque le socket a été ouvert (voir ci-dessus).</p>
<pre class="brush: js">socket.ondata = function (event) {
if (typeof event.data === 'string') {
console.log('Get a string: ' + event.data);
} else {
console.log('Get a Uint8Array');
}
}</pre>
<p>Comme l'événement {{event("data")}} est déclenché autant que nécessaire, il peut parfois être nécessaire d'interrompre le flux de données entrants. À cette fin, l'appel de la méthode {{domxref("TCPSocket.suspend()")}} mettra en pause la lecture des données entrantes et cessera le déclenchement de {{event("data")}}. Il est possible de recommencer la lecture des données en appelant la méthode {{domxref("TCPSocket.resume()")}} .</p>
<h3 id="Fermeture_d'un_socket">Fermeture d'un socket</h3>
<p>La fermeture d'un socket se fait simplement en utilisant {{domxref("TCPSocket.close()")}}.</p>
<h2 id="Standard">Standard</h2>
<p>Ne fait partie d'aucune spécification; Toutefois, cette API est discuté au sein du W3C dans le cadre du <a href="http://www.w3.org/2012/sysapps/" title="http://www.w3.org/2012/sysapps/">groupe de travail Applications Système</a> sous la dénomination de <a href="http://www.w3.org/TR/2015/NOTE-tcp-udp-sockets-20150723/">RAW sockets</a>.</p>
<h2 id="Voir_aussi">Voir aussi</h2>
<ul>
<li>{{domxref("TCPSocket")}}</li>
<li><a href="https://github.com/soapdog/firefoxos-sample-app-telnet-client" title="Firefox OS Simple Telnet Sample App">Firefox OS Simple Telnet Sample App</a></li>
</ul>
|
