Descripción
Usa la API de chrome.socket
para enviar y recibir datos a través de la red mediante conexiones TCP y UDP. Nota: A partir de Chrome 33, esta API dejó de estar disponible y se reemplazó por 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
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 muestra la llamada subyacente read().
RecvFromInfo
Propiedades
-
dirección
string
La dirección de la máquina remota.
-
datos
ArrayBuffer
-
puerto
número
-
resultCode
número
El resultCode que muestra la llamada subyacente recvfrom().
SecureOptions
Propiedades
-
tlsVersion
TLSVersionConstraints opcional
SocketInfo
Propiedades
-
Conectado
boolean
Indica si el socket subyacente está conectado o no.
Para los sockets
tcp
, esto seguirá siendo así incluso si se desconectó el par remoto. Leer o escribir en el socket puede generar un error, lo que sugiere que este socket debe desconectarse mediantedisconnect()
.En el caso de los sockets
udp
, esto solo representa si se especificó una dirección remota predeterminada para leer y escribir paquetes. -
localAddress
string 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
string opcional
Si el socket subyacente está conectado, contiene la dirección IPv4/6 del intercambio de tráfico.
-
peerPort
número opcional
Si el socket subyacente está conectado, contiene el puerto del par conectado.
-
socketType
El tipo de socket pasado. Será
tcp
oudp
.
SocketType
Enum
“tcp”
“udp”
TLSVersionConstraints
Propiedades
-
máx.
string opcional
-
min
string opcional
Las versiones mínima y máxima aceptables de TLS. Los valores admitidos son
tls1.2
otls1.3
.Ya no se admiten los valores
tls1
ytls1.1
. Simin
se establece en uno de estos valores, se fijará de manera silenciosa atls1.2
. Simax
se establece en uno de esos valores o cualquier otro valor no reconocido, se ignorará en silencio.
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 la función Escuchar. 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
Es el socketId.
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(acceptInfo: AcceptInfo) => void
-
acceptInfo
-
bind()
chrome.socket.bind(
socketId: number,
address: string,
port: number,
callback: function,
)
Vincula la dirección local del socket. Actualmente, no es compatible con el socket TCP.
Parámetros
-
socketId
número
Es el socketId.
-
dirección
string
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
). En el caso de un socket udp
, esto establece la dirección predeterminada desde la que se envían y se leen los paquetes para las llamadas read()
y write()
.
Parámetros
-
socketId
número
Es el socketId.
-
Nombre de host
string
El nombre de host o la dirección IP de la máquina remota.
-
puerto
número
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()
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
El tipo de socket a crear. Debe ser
tcp
oudp
. -
opciones
CreateOptions opcional
Las opciones del socket.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(createInfo: CreateInfo) => void
-
createInfo
-
Muestra
-
Promise<CreateInfo>
Chrome 121 y versiones posterioresLas promesas solo son compatibles con 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 del uso.
Parámetros
-
socketId
número
Es el socketId.
disconnect()
chrome.socket.disconnect(
socketId: number,
)
Desconecta el enchufe. En los sockets UDP, disconnect
no es una operación, pero es seguro llamarla.
Parámetros
-
socketId
número
Es el socketId.
getInfo()
chrome.socket.getInfo(
socketId: number,
callback?: function,
)
Recupera el estado de un socket determinado.
Parámetros
-
socketId
número
Es el socketId.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(result: SocketInfo) => void
-
resultado
-
Muestra
-
Promise<SocketInfo>
Chrome 121 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
getJoinedGroups()
chrome.socket.getJoinedGroups(
socketId: number,
callback: function,
)
Obtiene las direcciones del grupo de multidifusión a las que está unido el socket actualmente.
Parámetros
-
socketId
número
Es el socketId.
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(groups: string[]) => void
-
grupos
string[]
-
getNetworkList()
chrome.socket.getNetworkList(
callback?: function,
)
Recupera información sobre los adaptadores locales de este sistema.
Parámetros
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(result: NetworkInterface[]) => void
-
resultado
-
Muestra
-
Promise<NetworkInterface[]>
Chrome 121 y versiones posterioresLas promesas solo son compatibles con 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 de multidifusión y comienza a recibir paquetes de ese grupo. El socket debe ser de tipo UDP y debe vincularse a un puerto local antes de llamar a este método.
Parámetros
-
socketId
número
Es el socketId.
-
dirección
string
La dirección del grupo al que se 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 antes con joinGroup
. No es necesario salir del grupo de multidifusión antes de destruir el socket o salir. El SO lo llama automáticamente.
Si abandonas el grupo, el router no podrá enviar datagramas de multidifusión al host local, suponiendo que no hay ningún otro proceso del host unido al grupo.
Parámetros
-
socketId
número
Es el socketId.
-
dirección
string
La dirección del grupo que se 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. Detecta conexiones en el puerto y la dirección especificados. Efectivamente, esto hace que sea un socket de servidor, y las funciones de socket de cliente (conectar, leer y escribir) ya no se pueden usar en este socket.
Parámetros
-
socketId
número
Es el socketId.
-
dirección
string
La dirección de la máquina local.
-
puerto
número
El puerto de la máquina local.
-
tareas pendientes
número opcional
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 de un socket conectado determinado.
Parámetros
-
socketId
número
Es el socketId.
-
bufferSize
número opcional
El tamaño del búfer de lectura.
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(readInfo: ReadInfo) => void
-
readInfo
-
recvFrom()
chrome.socket.recvFrom(
socketId: number,
bufferSize?: number,
callback: function,
)
Recibe datos del socket UDP determinado.
Parámetros
-
socketId
número
Es el socketId.
-
bufferSize
número opcional
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
-
recvFromInfo
-
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
Las restricciones y los parámetros de 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 del socket UDP determinado a la dirección y al puerto especificados.
Parámetros
-
socketId
número
Es el socketId.
-
datos
ArrayBuffer
Los datos que se escribirán.
-
dirección
string
La dirección de la máquina remota.
-
puerto
número
El puerto de la máquina remota.
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(writeInfo: WriteInfo) => void
-
writeInfo
-
setKeepAlive()
chrome.socket.setKeepAlive(
socketId: number,
enable: boolean,
delay?: number,
callback: function,
)
Habilita o inhabilita la función keep-alive para una conexión TCP.
Parámetros
-
socketId
número
Es el socketId.
-
habilitar
boolean
Si es verdadero, habilita la funcionalidad keep-alive.
-
delay
número opcional
Establece el retraso en segundos entre el último paquete de datos recibido y el primer sondeo de keepalive. El valor predeterminado es 0.
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(result: boolean) => void
-
resultado
boolean
-
setMulticastLoopbackMode()
chrome.socket.setMulticastLoopbackMode(
socketId: number,
enabled: boolean,
callback: function,
)
Establece si los paquetes de multidifusión enviados desde el host al grupo de multidifusión se repetirán en bucle al host.
Nota: El comportamiento de setMulticastLoopbackMode
es ligeramente diferente entre los sistemas Windows y Unix. La incoherencia se produce solo cuando hay más de una aplicación en el mismo host unida al mismo grupo de multidifusión mientras hay diferentes configuraciones en el modo de bucle invertido de multidifusión. En Windows, las aplicaciones con el bucle invertido desactivado no RECIBIRán los paquetes de bucle invertido. mientras que en sistemas similares a Unix, las aplicaciones con bucles desactivados no ENVIARán los paquetes de bucle invertido a otras aplicaciones del mismo host. Consulta MSDN: http://goo.gl/6vqbj
Para llamar a este método, no se requieren permisos de multidifusión.
Parámetros
-
socketId
número
Es el socketId.
-
habilitado
boolean
Indica si se habilita 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 actividad de los paquetes de multidifusión enviados al grupo de multidifusión.
Para llamar a este método, no se requieren permisos de multidifusión.
Parámetros
-
socketId
número
Es el socketId.
-
ttl
número
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
Es el socketId.
-
noDelay
boolean
Si es verdadero, se inhabilita el algoritmo de Nagle.
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(result: boolean) => void
-
resultado
boolean
-
write()
chrome.socket.write(
socketId: number,
data: ArrayBuffer,
callback: function,
)
Escribe datos en el socket conectado determinado.