chrome.sockets.tcpServer

Descripción

Usa la API de chrome.sockets.tcpServer para crear aplicaciones de servidor mediante conexiones TCP. Esta API sustituye la funcionalidad de TCP que se encontraba anteriormente en la API de chrome.socket.

Manifiesto

Para usar esta API, se deben declarar las siguientes claves en el manifiesto.

"sockets"

Tipos

AcceptErrorInfo

Propiedades

  • resultCode

    número

    El código de resultado que muestra la llamada de red subyacente.

  • socketId

    número

    Es el identificador del socket de servidor.

AcceptInfo

Propiedades

  • clientSocketId

    número

    El identificador de socket del cliente, es decir, el identificador de socket de la conexión recién establecida. Este identificador de socket solo debe usarse con funciones del espacio de nombres chrome.sockets.tcp. Ten en cuenta que el socket del cliente se detiene inicialmente y la aplicación debe reanudarlo de forma explícita para comenzar a recibir datos.

  • socketId

    número

    Es el identificador del socket de servidor.

CreateInfo

Propiedades

  • socketId

    número

    El ID del socket de servidor recién creado. Ten en cuenta que los IDs de socket creados a partir de esta API no son compatibles con los IDs de socket creados a partir de otras APIs, como la API de [socket](../socket/) obsoleta.

SocketInfo

Propiedades

  • localAddress

    string opcional

    Si el socket está escuchando, contiene su dirección IPv4/6 local.

  • localPort

    número opcional

    Si el socket escucha, contiene su puerto local.

  • nombre

    string opcional

    Cadena definida por la aplicación asociada al socket.

  • detenido

    boolean

    Marca que indica si las solicitudes de conexión en un socket de escucha se envían a través del evento onAccept o se ponen en cola en las tareas pendientes de la cola de escucha. Consulta los setPaused. El valor predeterminado es "false".

  • persistentes

    boolean

    Marca que indica si el socket permanece abierto cuando se descarga la página de eventos de la aplicación (consulta SocketProperties.persistent). El valor predeterminado es "false".

  • socketId

    número

    El identificador del socket.

SocketProperties

Propiedades

  • nombre

    string opcional

    Una cadena definida por la aplicación asociada al socket.

  • persistentes

    booleano opcional

    Marca que indica si el socket permanece abierto cuando se descarga la página de eventos de la aplicación (consulta Administra el ciclo de vida de la app). El valor predeterminado es "false". Cuando se carga la aplicación, cualquier socket que se abrió previamente con Persistent=true se puede recuperar con getSockets.

Métodos

close()

Promesa 
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
)

Desconecta y destruye el enchufe. Cada socket creado debe cerrarse después de su uso. El ID del socket ya no es válido en cuanto se llama a la función. Sin embargo, se garantiza que el socket se cerrará solo cuando se invoque la devolución de llamada.

Parámetros

  • socketId

    número

    El identificador del socket.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 121 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

create()

Promesa 
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
)

Crea un socket de servidor TCP.

Parámetros

  • properties

    SocketProperties opcional

    Las propiedades del socket (opcional)

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      El resultado de la creación del socket.

Muestra

  • Promise&lt;CreateInfo&gt;

    Chrome 121 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

disconnect()

Promesa 
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
)

Desconecta el socket de escucha, es decir, deja de aceptar nuevas conexiones y libera la dirección o el puerto al que está vinculado el socket. El identificador del socket sigue siendo válido, p.ej., se puede usar con listen para aceptar conexiones en un puerto y una dirección nuevos.

Parámetros

  • socketId

    número

    El identificador del socket.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 121 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getInfo()

Promesa 
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
)

Recupera el estado de un socket determinado.

Parámetros

  • socketId

    número

    El identificador del socket.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Objeto que contiene la información del socket.

Muestra

  • Promise&lt;SocketInfo&gt;

    Chrome 121 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getSockets()

Promesa 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

Recupera la lista de sockets abiertos actualmente que pertenecen a la aplicación.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      Array de objeto que contiene información del socket.

Muestra

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

listen()

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

Detecta conexiones en el puerto y la dirección especificados. Si el puerto o la dirección están en uso, la devolución de llamada indica un error.

Parámetros

  • socketId

    número

    El identificador del socket.

  • dirección

    string

    La dirección de la máquina local.

  • puerto

    número

    El puerto de la máquina local. Cuando se establece en 0, se elige un puerto libre de forma dinámica. El puerto asignado de forma dinámica se puede encontrar llamando a getInfo.

  • tareas pendientes

    número opcional

    Longitud de la cola de escucha del socket. El valor predeterminado depende del sistema operativo (SOMAXCONN), que garantiza una longitud de cola razonable para la mayoría de las aplicaciones.

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (result: number) => void

    • resultado

      número

      El código de resultado que muestra la llamada de red subyacente. Un valor negativo indica un error.

setPaused()

Promesa 
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Habilita o inhabilita un socket de escucha para que no acepte conexiones nuevas. Cuando se pausa, un socket de escucha acepta conexiones nuevas hasta que el trabajo pendiente (consulta la función listen) se completa y, luego, rechaza las solicitudes de conexión adicionales. Los eventos onAccept solo se generan cuando se reanuda el socket.

Parámetros

  • socketId

    número

  • detenido

    boolean

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 121 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

update()

Promesa 
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

Actualiza las propiedades del socket.

Parámetros

  • socketId

    número

    El identificador del socket.

  • properties

    SocketProperties

    Las propiedades que se actualizarán.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 121 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

Eventos

onAccept

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

Evento generado cuando se establece una conexión al socket de servidor.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (info: AcceptInfo) => void

onAcceptError

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

Evento generado cuando se produjo un error de red mientras el entorno de ejecución estaba esperando nuevas conexiones en la dirección y el puerto del socket. Una vez que se genera este evento, el socket se establece en paused y no se generan más eventos onAccept para este socket hasta que se reanude.

Parámetros