Descripción
Usa la API de chrome.sockets.udp
para enviar y recibir datos a través de la red con conexiones UDP. Esta API reemplaza la funcionalidad de UDP que se encontraba anteriormente en la API de "socket".
Manifiesto
Tipos
CreateInfo
Propiedades
-
socketId
número
El ID del socket 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.
DnsQueryType
Preferencias de resolución de DNS El valor predeterminado es any
y usa la configuración actual del SO, que puede mostrar IPv4 o IPv6. ipv4
fuerza IPv4 y ipv6
fuerza IPv6.
Enum
"any"
"ipv4"
"ipv6"
ReceiveErrorInfo
Propiedades
-
resultCode
número
Es el código de resultado que se muestra desde la llamada recvfrom() subyacente.
-
socketId
número
Es el ID del socket.
ReceiveInfo
Propiedades
-
datos
ArrayBuffer
El contenido del paquete UDP (truncado al tamaño del búfer actual)
-
remoteAddress
string
Es la dirección del host del que proviene el paquete.
-
remotePort
número
Es el puerto del host del que proviene el paquete.
-
socketId
número
Es el ID del socket.
SendInfo
Propiedades
-
bytesSent
número opcional
La cantidad de bytes enviados (si el resultado es igual a 0)
-
resultCode
número
Es el código de resultado que se muestra desde la llamada de red subyacente. Un valor negativo indica un error.
SocketInfo
Propiedades
-
bufferSize
número opcional
Es el tamaño del búfer que se usa para recibir datos. Si no se especificó explícitamente un tamaño de búfer, no se proporciona el valor.
-
localAddress
cadena opcional
Si el socket subyacente está vinculado, contiene su dirección IPv4/6 local.
-
localPort
número opcional
Si el socket subyacente está vinculado, contiene su puerto local.
-
nombre
cadena opcional
Es la cadena definida por la aplicación asociada con el socket.
-
detenido
booleano
Marca que indica si el socket está bloqueado para activar eventos onReceive.
-
persistentes
booleano
Marca que indica si el socket se deja abierto cuando se suspende la aplicación (consulta
SocketProperties.persistent
). -
socketId
número
El identificador del socket.
SocketProperties
Propiedades
-
bufferSize
número opcional
Es el tamaño del búfer que se usa para recibir datos. Si el búfer es demasiado pequeño para recibir el paquete UDP, se pierden los datos. El valor predeterminado es 4096.
-
nombre
cadena opcional
Es una cadena definida por la aplicación asociada con el socket.
-
persistentes
booleano opcional
Marca que indica si el socket se deja abierto cuando se descarga la página de eventos de la aplicación (consulta Cómo administrar el ciclo de vida de la app). El valor predeterminado es "false". Cuando se carga la aplicación, se pueden recuperar con
getSockets
los sockets que se abrieron anteriormente con persistent=true.
Métodos
bind()
chrome.sockets.udp.bind(
socketId: number,
address: string,
port: number,
callback: function,
)
Vincula la dirección y el puerto locales para el socket. Para un socket de cliente, se recomienda usar el puerto 0 para permitir que la plataforma elija un puerto libre.
Una vez que se completa correctamente la operación bind
, se generan eventos onReceive
cuando llegan paquetes UDP a la dirección o el puerto especificados, a menos que se detenga el socket.
Parámetros
-
socketId
número
Es el ID del socket.
-
dirección
string
Es la dirección de la máquina local. Se admiten los formatos de nombre de DNS, IPv4 e IPv6. Usa "0.0.0.0" para aceptar paquetes de todas las interfaces de red locales disponibles.
-
puerto
número
El puerto de la máquina local. Usa “0” para vincularlo a un puerto libre.
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(result: number) => void
-
resultado
número
Es el código de resultado que se muestra desde la llamada de red subyacente. Un valor negativo indica un error.
-
close()
chrome.sockets.udp.close(
socketId: number,
callback?: function,
)
Cierra el socket y libera la dirección o el puerto al que está vinculado. Cada socket creado debe cerrarse después de usarlo. 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 cierre solo cuando se invoque la devolución de llamada.
Parámetros
-
socketId
número
Es el ID del socket.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promise<void>
Chrome 121 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.
create()
chrome.sockets.udp.create(
properties?: SocketProperties,
callback?: function,
)
Crea un socket UDP con las propiedades especificadas.
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
Es el resultado de la creación del socket.
-
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.
getInfo()
chrome.sockets.udp.getInfo(
socketId: number,
callback?: function,
)
Recupera el estado del socket determinado.
Parámetros
-
socketId
número
Es el ID del socket.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(socketInfo: SocketInfo) => void
-
socketInfo
Objeto que contiene la información del socket.
-
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.sockets.udp.getJoinedGroups(
socketId: number,
callback?: function,
)
Obtiene las direcciones del grupo multicast al que se unió el socket.
Parámetros
-
socketId
número
Es el ID del socket.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(groups: string[]) => void
-
grupos
string[]
Es un array de grupos a los que se unió el socket.
-
Muestra
-
Promise<string[]>
Chrome 121 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.
getSockets()
chrome.sockets.udp.getSockets(
callback?: function,
)
Recupera la lista de los 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
Es un array de objetos que contiene información del socket.
-
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.
joinGroup()
chrome.sockets.udp.joinGroup(
socketId: number,
address: string,
callback: function,
)
Se une al grupo multicast y comienza a recibir paquetes de ese grupo. El socket debe estar vinculado a un puerto local antes de llamar a este método.
Parámetros
-
socketId
número
Es el ID del socket.
-
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
Es el código de resultado que se muestra desde la llamada de red subyacente. Un valor negativo indica un error.
-
leaveGroup()
chrome.sockets.udp.leaveGroup(
socketId: number,
address: string,
callback: function,
)
Abandona el grupo multicast al que te uniste anteriormente con joinGroup
. Solo es necesario llamar a esta función si planeas seguir usando el socket más adelante, ya que el SO lo hará automáticamente cuando se cierre.
Si abandonas el grupo, el router no podrá enviar datagramas multicast al host local, siempre y cuando ningún otro proceso en el host siga unido al grupo.
Parámetros
-
socketId
número
Es el ID del socket.
-
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
Es el código de resultado que se muestra desde la llamada de red subyacente. Un valor negativo indica un error.
-
send()
chrome.sockets.udp.send(
socketId: number,
data: ArrayBuffer,
address: string,
port: number,
dnsQueryType?: DnsQueryType,
callback: function,
)
Envía datos en el socket determinado a la dirección y el puerto determinados. El socket debe estar vinculado a un puerto local antes de llamar a este método.
Parámetros
-
socketId
número
Es el ID del socket.
-
datos
ArrayBuffer
Los datos que se enviarán
-
dirección
string
Es la dirección de la máquina remota.
-
puerto
número
Es el puerto de la máquina remota.
-
dnsQueryType
DnsQueryType: Opcional
Chrome 103 y versiones posterioresEs la preferencia de resolución de direcciones.
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(sendInfo: SendInfo) => void
-
sendInfo
Es el resultado del método
send
.
-
setBroadcast()
chrome.sockets.udp.setBroadcast(
socketId: number,
enabled: boolean,
callback: function,
)
Habilita o inhabilita los paquetes de transmisión en este socket.
Parámetros
-
socketId
número
Es el ID del socket.
-
habilitado
booleano
true
para habilitar los paquetes de transmisión,false
para inhabilitarlos. -
callback
función
El parámetro
callback
se ve de la siguiente manera:(result: number) => void
-
resultado
número
Es el código de resultado que se muestra desde la llamada de red subyacente.
-
setMulticastLoopbackMode()
chrome.sockets.udp.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
Es el ID del socket.
-
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
Es el código de resultado que se muestra desde la llamada de red subyacente. Un valor negativo indica un error.
-
setMulticastTimeToLive()
chrome.sockets.udp.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
Es el ID del socket.
-
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
Es el código de resultado que se muestra desde la llamada de red subyacente. Un valor negativo indica un error.
-
setPaused()
chrome.sockets.udp.setPaused(
socketId: number,
paused: boolean,
callback?: function,
)
Pausa o reanuda un socket. Se bloquea un socket detenido para que no active eventos onReceive
.
Parámetros
-
socketId
número
-
detenido
booleano
Marca que indica si se debe pausar o reanudar.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promise<void>
Chrome 121 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.
update()
chrome.sockets.udp.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
Actualiza las propiedades del socket.
Parámetros
-
socketId
número
Es el ID del socket.
-
properties
Las propiedades que se actualizarán.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promise<void>
Chrome 121 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.
Eventos
onReceive
chrome.sockets.udp.onReceive.addListener(
callback: function,
)
Se genera un evento cuando se recibe un paquete UDP para el socket determinado.
Parámetros
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(info: ReceiveInfo) => void
-
información
-
onReceiveError
chrome.sockets.udp.onReceiveError.addListener(
callback: function,
)
Se genera un evento cuando se produce un error de red mientras el entorno de ejecución espera datos en la dirección y el puerto del socket. Una vez que se genera este evento, se pausa el socket y no se generarán más eventos onReceive
para este socket hasta que se reanude.
Parámetros
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(info: ReceiveErrorInfo) => void
-
información
-