chrome.socket

Descripción

Usa la API de chrome.socket para enviar y recibir datos a través de la red con conexiones TCP y UDP. Nota: A partir de Chrome 33, esta API dejó de estar disponible a favor de las APIs de sockets.udp, sockets.tcp y sockets.tcpServer.

Permisos

socket

Tipos

AcceptInfo

Propiedades

  • resultCode

    número

  • socketId

    número opcional

    El ID del socket aceptado.

CreateInfo

Propiedades

  • socketId

    número

    El ID del socket recién creado.

CreateOptions

NetworkInterface

Propiedades

  • dirección

    string

    La dirección IPv4/6 disponible.

  • nombre

    string

    Es el nombre subyacente del adaptador. En *nix, suele ser “eth0”, “lo”, etcétera.

  • prefixLength

    número

    La longitud del prefijo

ReadInfo

Propiedades

  • datos

    ArrayBuffer

  • resultCode

    número

    El resultCode que se muestra desde la llamada read().

RecvFromInfo

Propiedades

  • dirección

    string

    Es la dirección de la máquina remota.

  • datos

    ArrayBuffer

  • puerto

    número

  • resultCode

    número

    El resultCode que se muestra desde la llamada recvfrom() subyacente.

SecureOptions

Propiedades

SocketInfo

Propiedades

  • Conectado

    booleano

    Indica si el zócalo subyacente está conectado o no.

    En el caso de los sockets tcp, esto seguirá siendo cierto incluso si el par remoto se desconectó. La lectura o escritura en el socket puede generar un error, lo que indica que este socket debe desconectarse a través de disconnect().

    En el caso de los sockets udp, solo representa si se especificó una dirección remota predeterminada para leer y escribir paquetes.

  • localAddress

    cadena opcional

    Si el socket subyacente está vinculado o conectado, contiene su dirección IPv4/6 local.

  • localPort

    número opcional

    Si el socket subyacente está vinculado o conectado, contiene su puerto local.

  • peerAddress

    cadena opcional

    Si el socket subyacente está conectado, contiene la dirección IPv4/6 del par.

  • peerPort

    número opcional

    Si el socket subyacente está conectado, contiene el puerto del par conectado.

  • socketType

    SocketType

    Es el tipo de socket pasado. Será tcp o udp.

SocketType

Enum

"tcp"

"udp"

TLSVersionConstraints

Propiedades

  • máx.

    cadena opcional

  • min

    cadena opcional

    Las versiones mínimas y máximas aceptables de TLS Los valores admitidos son tls1.2 o tls1.3.

    Los valores tls1 y tls1.1 ya no se admiten. Si min se establece en uno de estos valores, se restringirá de forma silenciosa a tls1.2. Si max se establece en uno de esos valores, o en cualquier otro valor no reconocido, se ignorará de forma silenciosa.

WriteInfo

Propiedades

  • bytesWritten

    número

    La cantidad de bytes enviados o un código de error negativo

Métodos

accept()

chrome.socket.accept(
  socketId: number,
  callback: function,
)

Este método solo se aplica a los sockets TCP. Registra una función de devolución de llamada a la que se llamará cuando se acepte una conexión en este socket de servidor de escucha. Primero, se debe llamar a Listen. Si ya hay una devolución de llamada de aceptación activa, esta se invocará de inmediato con un error como resultCode.

Parámetros

  • socketId

    número

    El socketId.

  • callback

    función

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

    (acceptInfo: AcceptInfo) => void

bind()

chrome.socket.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
)

Vincula la dirección local para el socket. Actualmente, no admite el socket TCP.

Parámetros

  • socketId

    número

    El socketId.

  • dirección

    string

    Es la dirección de la máquina local.

  • puerto

    número

    El puerto de la máquina local.

  • callback

    función

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

    (result: number) => void

    • resultado

      número

connect()

chrome.socket.connect(
  socketId: number,
  hostname: string,
  port: number,
  callback: function,
)

Conecta el socket a la máquina remota (para un socket tcp). Para un socket udp, establece la dirección predeterminada a la que se envían y desde la que se leen los paquetes para las llamadas read() y write().

Parámetros

  • socketId

    número

    El socketId.

  • Nombre de host

    string

    El nombre de host o la dirección IP de la máquina remota.

  • puerto

    número

    Es el puerto de la máquina remota.

  • callback

    función

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

    (result: number) => void

    • resultado

      número

create()

Promesa 
chrome.socket.create(
  type: SocketType,
  options?: CreateOptions,
  callback?: function,
)

Crea un socket del tipo especificado que se conectará a la máquina remota especificada.

Parámetros

  • tipo

    SocketType

    Es el tipo de socket que se creará. Debe ser tcp o udp.

  • opciones

    CreateOptions opcional

    Las opciones de socket

  • callback

    función opcional

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

    (createInfo: CreateInfo) => void

Muestra

  • Promise<CreateInfo>

    Chrome 121 y versiones posteriores

    Las promesas solo se admiten para Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

destroy()

chrome.socket.destroy(
  socketId: number,
)

Destruye el socket. Cada socket creado debe destruirse después de su uso.

Parámetros

  • socketId

    número

    El socketId.

disconnect()

chrome.socket.disconnect(
  socketId: number,
)

Desconecta el enchufe. Para los sockets UDP, disconnect no es una operación, pero es seguro llamarlo.

Parámetros

  • socketId

    número

    El socketId.

getInfo()

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

Recupera el estado del socket determinado.

Parámetros

  • socketId

    número

    El socketId.

  • callback

    función opcional

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

    (result: SocketInfo) => void

Muestra

  • Promise<SocketInfo>

    Chrome 121 y versiones posteriores

    Las promesas solo se admiten para Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getJoinedGroups()

chrome.socket.getJoinedGroups(
  socketId: number,
  callback: function,
)

Obtén las direcciones de grupo multicast a las que se unió el socket actualmente.

Parámetros

  • socketId

    número

    El socketId.

  • callback

    función

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

    (groups: string[]) => void

    • grupos

      string[]

getNetworkList()

Promesa 
chrome.socket.getNetworkList(
  callback?: function,
)

Recupera información sobre los adaptadores locales en este sistema.

Parámetros

Muestra

  • Promise<NetworkInterface[]>

    Chrome 121 y versiones posteriores

    Las promesas solo se admiten para Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

joinGroup()

chrome.socket.joinGroup(
  socketId: number,
  address: string,
  callback: function,
)

Únete al grupo multicast y comienza a recibir paquetes de ese grupo. El socket debe ser de tipo UDP y debe estar vinculado a un puerto local antes de llamar a este método.

Parámetros

  • socketId

    número

    El socketId.

  • dirección

    string

    La dirección del grupo al que te quieres unir. No se admiten nombres de dominios.

  • callback

    función

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

    (result: number) => void

    • resultado

      número

leaveGroup()

chrome.socket.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
)

Abandona el grupo multicast al que te uniste anteriormente con joinGroup. No es necesario salir del grupo multicast antes de destruir el socket o salir. El SO lo llama automáticamente.

Si abandonas el grupo, el router no podrá enviar datagramas multicast al host local, siempre y cuando no haya otro proceso en el host que aún esté unido al grupo.

Parámetros

  • socketId

    número

    El socketId.

  • dirección

    string

    La dirección del grupo que quieres abandonar. No se admiten nombres de dominios.

  • callback

    función

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

    (result: number) => void

    • resultado

      número

listen()

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

Este método solo se aplica a los sockets TCP. Escucha las conexiones en el puerto y la dirección especificados. Esto lo convierte en un socket de servidor, y las funciones de socket de cliente (conexión, lectura y escritura) ya no se pueden usar en este socket.

Parámetros

  • socketId

    número

    El socketId.

  • dirección

    string

    Es la dirección de la máquina local.

  • puerto

    número

    El puerto de la máquina local.

  • lista

    número opcional

    Es la longitud de la cola de escucha del socket.

  • callback

    función

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

    (result: number) => void

    • resultado

      número

read()

chrome.socket.read(
  socketId: number,
  bufferSize?: number,
  callback: function,
)

Lee datos del socket conectado determinado.

Parámetros

  • socketId

    número

    El socketId.

  • bufferSize

    número opcional

    Es el tamaño del búfer de lectura.

  • callback

    función

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

    (readInfo: ReadInfo) => void

recvFrom()

chrome.socket.recvFrom(
  socketId: number,
  bufferSize?: number,
  callback: function,
)

Recibe datos del socket UDP determinado.

Parámetros

  • socketId

    número

    El socketId.

  • bufferSize

    número opcional

    Es el tamaño del búfer de recepción.

  • callback

    función

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

    (recvFromInfo: RecvFromInfo) => void

secure()

chrome.socket.secure(
  socketId: number,
  options?: SecureOptions,
  callback: function,
)

Inicia una conexión de cliente TLS a través de un socket de cliente TCP conectado.

Parámetros

  • socketId

    número

    El enchufe conectado que se usará.

  • opciones

    SecureOptions opcional

    Restricciones y parámetros para la conexión TLS.

  • callback

    función

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

    (result: number) => void

    • resultado

      número

sendTo()

chrome.socket.sendTo(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  callback: function,
)

Envía datos en el socket UDP determinado a la dirección y el puerto determinados.

Parámetros

  • socketId

    número

    El socketId.

  • datos

    ArrayBuffer

    Los datos que se escribirán.

  • dirección

    string

    Es la dirección de la máquina remota.

  • puerto

    número

    Es el puerto de la máquina remota.

  • callback

    función

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

    (writeInfo: WriteInfo) => void

setKeepAlive()

chrome.socket.setKeepAlive(
  socketId: number,
  enable: boolean,
  delay?: number,
  callback: function,
)

Habilita o inhabilita la funcionalidad de mantenimiento de la conexión para una conexión TCP.

Parámetros

  • socketId

    número

    El socketId.

  • habilitar

    booleano

    Si es verdadero, habilita la funcionalidad de mantenimiento de la conexión.

  • delay

    número opcional

    Establece la cantidad de segundos de retraso entre el último paquete de datos recibido y el primer sondeo de mantenimiento de la conexión. El valor predeterminado es 0.

  • callback

    función

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

    (result: boolean) => void

    • resultado

      booleano

setMulticastLoopbackMode()

chrome.socket.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
)

Establece si los paquetes de multidifusión que se envían del host al grupo de multidifusión se volverán a enviar al host.

Nota: El comportamiento de setMulticastLoopbackMode es ligeramente diferente entre Windows y los sistemas similares a Unix. La incoherencia ocurre solo cuando hay más de una aplicación en el mismo host que se unió al mismo grupo multicast y tiene parámetros de configuración diferentes en el modo de bucle invertido multicast. En Windows, las aplicaciones con el bucle invertido desactivado no RECIBIRÁN los paquetes de bucle invertido. En cambio, en los sistemas similares a Unix, las aplicaciones con el bucle invertido desactivado no ENVIARÁN los paquetes de bucle invertido a otras aplicaciones en el mismo host. Consulta MSDN: http://goo.gl/6vqbj

Llamar a este método no requiere permisos de multicast.

Parámetros

  • socketId

    número

    El socketId.

  • habilitado

    booleano

    Indica si se debe habilitar el modo de bucle invertido.

  • callback

    función

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

    (result: number) => void

    • resultado

      número

setMulticastTimeToLive()

chrome.socket.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)

Establece el tiempo de vida de los paquetes de multidifusión que se envían al grupo de multidifusión.

Llamar a este método no requiere permisos de multicast.

Parámetros

  • socketId

    número

    El socketId.

  • ttl

    número

    Es el valor del tiempo de actividad.

  • callback

    función

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

    (result: number) => void

    • resultado

      número

setNoDelay()

chrome.socket.setNoDelay(
  socketId: number,
  noDelay: boolean,
  callback: function,
)

Establece o borra TCP_NODELAY para una conexión TCP. El algoritmo de Nagle se inhabilitará cuando se configure TCP_NODELAY.

Parámetros

  • socketId

    número

    El socketId.

  • noDelay

    booleano

    Si es verdadero, inhabilita el algoritmo de Nagle.

  • callback

    función

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

    (result: boolean) => void

    • resultado

      booleano

write()

chrome.socket.write(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
)

Escribe datos en el socket conectado determinado.

Parámetros

  • socketId

    número

    El socketId.

  • datos

    ArrayBuffer

    Los datos que se escribirán.

  • callback

    función

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

    (writeInfo: WriteInfo) => void