chrome.sockets.tcpServer

Description

Utilisez l'API chrome.sockets.tcpServer pour créer des applications de serveur à l'aide de connexions TCP. Cette API remplace la fonctionnalité TCP précédemment disponible dans l'API chrome.socket.

Fichier manifeste

Les clés suivantes doivent être déclarées dans le fichier manifeste pour utiliser cette API.

"sockets"

Types

AcceptErrorInfo

Propriétés

  • resultCode

    Nombre

    Code de résultat renvoyé par l'appel réseau sous-jacent.

  • socketId

    Nombre

    Identifiant de socket du serveur.

AcceptInfo

Propriétés

  • clientSocketId

    Nombre

    Identifiant de socket client, c'est-à-dire l'identifiant de socket de la nouvelle connexion. Cet identifiant de socket ne doit être utilisé qu'avec des fonctions de l'espace de noms chrome.sockets.tcp. Notez que le socket client est initialement mis en pause et doit être explicitement réactivé par l'application pour commencer à recevoir des données.

  • socketId

    Nombre

    Identifiant de socket du serveur.

CreateInfo

Propriétés

  • socketId

    Nombre

    ID du socket serveur nouvellement créé. Notez que les ID de socket créés à partir de cette API ne sont pas compatibles avec ceux créés à partir d'autres API, comme l'API [socket](../socket/) obsolète.

SocketInfo

Propriétés

  • localAddress

    chaîne facultatif

    Si le socket écoute, contient son adresse IPv4/6 locale.

  • localPort

    numéro facultatif

    Si le socket écoute, contient son port local.

  • nom

    chaîne facultatif

    Chaîne définie par l'application associée au socket.

  • mis en veille

    booléen

    Indique si les requêtes de connexion sur un socket d'écoute sont distribuées via l'événement onAccept ou placées en file d'attente dans les tâches en attente de la file d'attente d'écoute. Consultez les setPaused. La valeur par défaut est "false".

  • SSD

    booléen

    Indique si le socket reste ouvert lorsque la page d'événement de l'application est déchargée (voir SocketProperties.persistent). La valeur par défaut est "false".

  • socketId

    Nombre

    Identifiant de socket.

SocketProperties

Propriétés

  • nom

    chaîne facultatif

    Chaîne définie par l'application associée au socket.

  • SSD

    Booléen facultatif

    Indique si le socket reste ouvert lorsque la page d'événement de l'application est déchargée (voir Gérer le cycle de vie de l'application). La valeur par défaut est "false". Lorsque l'application est chargée, tous les sockets précédemment ouverts avec "persistant=true" peuvent être récupérés avec getSockets.

Méthodes

close()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
)

Débranche et détruit le socket. Chaque socket créé doit être fermé après utilisation. L'ID de socket n'est plus valide dès que la fonction est appelée. Toutefois, la fermeture du socket n'est garantie que lorsque le rappel est appelé.

Paramètres

  • socketId

    Nombre

    Identifiant de socket.

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 121 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

create()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
)

Crée un socket serveur TCP.

Paramètres

  • du bucket

    SocketProperties facultatif

    Propriétés du socket (facultatif).

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Résultat de la création du socket.

Renvoie

  • Promise&lt;CreateInfo&gt;

    Chrome 121 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

disconnect()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
)

Déconnecte le socket d'écoute, c'est-à-dire cesse d'accepter de nouvelles connexions et libère l'adresse ou le port auquel le socket est lié. L'identifiant de socket reste valide, par exemple Il peut être utilisé avec listen pour accepter les connexions sur un nouveau port et une nouvelle adresse.

Paramètres

  • socketId

    Nombre

    Identifiant de socket.

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 121 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getInfo()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
)

Récupère l'état du socket donné.

Paramètres

  • socketId

    Nombre

    Identifiant de socket.

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Objet contenant les informations de socket

Renvoie

  • Promise&lt;SocketInfo&gt;

    Chrome 121 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getSockets()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

Récupère la liste des sockets actuellement ouverts appartenant à l'application.

Paramètres

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      Tableau d'objets contenant des informations de socket.

Renvoie

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

listen()

chrome.sockets.tcpServer.listen(
  socketId: number,
  address: string,
  port: number,
  backlog?: number,
  callback: function,
)

Écoute les connexions sur le port et l'adresse spécifiés. Si le port ou l'adresse sont utilisés, le rappel indique un échec.

Paramètres

  • socketId

    Nombre

    Identifiant de socket.

  • adresse

    chaîne

    Adresse de la machine locale.

  • port

    Nombre

    Port de la machine locale. Lorsque ce paramètre est défini sur 0, un port libre est choisi de manière dynamique. Vous pouvez trouver le port alloué dynamiquement en appelant getInfo.

  • en attente

    numéro facultatif

    Longueur de la file d'attente d'écoute du socket. La valeur par défaut dépend du système d'exploitation (SOMAXCONN), ce qui garantit une longueur de file d'attente raisonnable pour la plupart des applications.

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (result: number) => void

    • résultat

      Nombre

      Code de résultat renvoyé par l'appel réseau sous-jacent. Une valeur négative indique une erreur.

setPaused()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Active ou désactive l'acceptation de nouvelles connexions par un socket d'écoute. Lorsqu'elle est suspendue, un socket d'écoute accepte de nouvelles connexions jusqu'à ce que le nombre de connexions en attente (voir la fonction listen) soit saturé, puis refuse les demandes de connexion supplémentaires. Les événements onAccept ne sont déclenchés que lorsque le socket est réactivé.

Paramètres

  • socketId

    Nombre

  • mis en veille

    booléen

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 121 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

update()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

Met à jour les propriétés du socket.

Paramètres

  • socketId

    Nombre

    Identifiant de socket.

  • du bucket

    SocketProperties

    Propriétés à mettre à jour.

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 121 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onAccept

chrome.sockets.tcpServer.onAccept.addListener(
  callback: function,
)

Événement déclenché lorsqu'une connexion a été établie avec le socket serveur.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (info: AcceptInfo) => void

onAcceptError

chrome.sockets.tcpServer.onAcceptError.addListener(
  callback: function,
)

Événement déclenché lorsqu'une erreur réseau se produit alors que l'environnement d'exécution attendait de nouvelles connexions sur l'adresse et le port de socket. Une fois cet événement déclenché, le socket est défini sur paused, et aucun autre événement onAccept n'est déclenché pour ce socket tant qu'il n'est pas réactivé.

Paramètres