TCPSocket

Cette traduction est incomplète. Aidez à traduire cet article depuis l'anglais.

Non standard
Cette fonctionnalité n'est ni standard, ni en voie de standardisation. Ne l'utilisez pas pour des sites accessibles sur le Web : elle ne fonctionnera pas pour tout utilisateur. Il peut également y avoir d'importantes incompatibilités entre les implémentations et son comportement peut être modifié dans le futur.

Cette API est disponible sur Firefox OS pour des applications privilégiées ou certifiées seulement.

Résumé

L'interface TCPSocket permet d'accéder à un socket TCP brut.

Le principal point de cette API d'entrée est la propriéténavigator.mozTCPSocket qui est un object TCPSocket.

Note: Seulement applications certifiées peuvent accepter des connexions entrantes sur un port en dessous de 1024.

Aperçu de l'API

interface TCPSocket{
  readonly attribute DOMString host;
  readonly attribute unsigned short port;
  readonly attribute boolean ssl;
  readonly attribute unsigned long bufferedAmount;
  readonly attribute DOMString binaryType;
  readonly attribute DOMString readyState;

  TCPSocket open(DOMString host, unsigned short port, [object options]);
  TCPServerSocket listen(unsigned short port, [object options, [unsigned short backlog]]);
  void upgradeToSecure();
  void suspend();
  void resume();
  void close();
  boolean send(in jsval data);

  attribute onopen;
  attribute ondrain;
  attribute ondata;
  attribute onerror;
  attribute onclose;
};

Propriétés

TCPSocket.host Lecture seule
Une chaîne représentant le nom du serveur sur le quel le socket est connecté.
TCPSocket.port Lecture seule
Un nombre représentant le port de connexion.
TCPSocket.ssl Lecture seule
Une valeur booléenne indiquant si le socket est cryptée avec SSL (true) ou non (false).
TCPSocket.bufferedAmount Lecture seule
Le nombre d'octets de données dans le tampon qui ne sont pas encore envoyés.
TCPSocket.binaryType Lecture seule
Le type de données utilisé. Valeurs possibles : arraybuffer ou string.
TCPSocket.readyState Lecture seule
L'état de socket. Valeurs possibles : connecting, open, closing, ou closed.

Gestionnaires d'Evénements

TCPSocket.onopen
Gestionnaire d'événement open. Après cet événement, le socket est prêt à envoyer et recevoir des données.
TCPSocket.ondrain
Gestionnaire pour l'événement drain. Cet événement est déclenché chaque fois que le tampon de données est vidé.
TCPSocket.onerror
Gestionnaire pour l'événement error.
TCPSocket.ondata
Gestionnaire pour l'événement data. Cet événement est déclenché chaque fois que les données ont été reçues.
TCPSocket.onclose
Gestionnaire pour l'événement close.

Méthodes

TCPSocket.close()
Ferme la connexion.
TCPSocket.open(host, port [, options])
Renvoie un nouvel objet connecté TCPSocket aux host donnée et au port donné.
TCPSocket.listen(port [, options [, backlog]]) Nécessite FirefoxOS 1.2
Renvoie un nouvel objet TCPServerSocket écoutant au port donné.
TCPSocket.resume()
Information sur l'événement data.
TCPSocket.send(data)
Données tampons à envoyer sur le réseau.
TCPSocket.suspend()
Suspend l'événement data.
TCPSocket.upgradeToSecure() Nécessite FirefoxOS 1.2
Sécurité du canal.

Spécification

Ne fait partie d'aucune spécification; Toutefois, cette API est discuté au sein du W3C dans le cadre du groupe de travail des applications  système sous la dénomination API Socket TCP et UDP (anciennement connu sous le nom Raw Sockets API) .

Voir aussi

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : jmh
 Dernière mise à jour par : jmh,