--- title: TCPSocket slug: Web/API/TCPSocket translation_of: Archive/B2G_OS/API/TCPSocket ---

{{APIRef("Firefox OS")}}

{{ non-standard_header() }}

{{ B2GOnlyHeader2('privileged') }}

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é{{domxref("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

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

Gestionnaires d'Evénements

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

Méthodes

{{domxref("TCPSocket.close()")}}
Ferme la connexion.
{{domxref("TCPSocket.open()","TCPSocket.open(host, port [, options])")}}
Renvoie un nouvel objet connecté TCPSocket aux host donnée et au port donné.
{{domxref("TCPSocket.resume()")}}
Information sur l'événement data.
{{domxref("TCPSocket.send()","TCPSocket.send(data)")}}
Données tampons à envoyer sur le réseau.
{{domxref("TCPSocket.suspend()")}}
Suspend l'événement data.

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