chrome.socket

说明

使用 chrome.socket API，借助 TCP 和 UDP 连接通过网络发送和接收数据。注意：从 Chrome 33 开始，此 API 已弃用，取而代之的是 sockets.udp、sockets.tcp 和 sockets.tcpServer API。

权限

socket

类型

AcceptInfo

属性

  • resultCode

    number

  • socketId

    数字可选

    已接受的套接字的 ID。

CreateInfo

属性

  • socketId

    number

    新创建的套接字的 ID。

CreateOptions

NetworkInterface

属性

  • 地址

    string

    可用的 IPv4/6 地址。

  • name

    string

    适配器的基础名称。在 *nix 上，该名称通常为“eth0”“lo”等。

  • prefixLength

    number

    前缀长度

ReadInfo

属性

  • data

    ArrayBuffer

  • resultCode

    number

    从底层 read() 调用返回的 resultCode。

RecvFromInfo

属性

  • 地址

    string

    远程计算机的地址。

  • data

    ArrayBuffer

  • 端口

    number

  • resultCode

    number

    从底层 recvfrom() 调用返回的 resultCode。

SecureOptions

属性

SocketInfo

属性

  • 已连接

    boolean

    底层套接字是否已连接。

    对于 tcp 套接字，即使远程对等方已断开连接，此值仍为 true。然后，读取或写入套接字可能会导致错误，提示此套接字应通过 disconnect() 断开连接。

    对于 udp 套接字，这仅表示是否已指定默认远程地址来读取和写入数据包。

  • localAddress

    字符串（可选）

    如果底层套接字已经过绑定或连接，则包含其本地 IPv4/6 地址。

  • localPort

    数字可选

    如果底层套接字已经过绑定或连接，则包含其本地端口。

  • peerAddress

    字符串（可选）

    如果底层套接字已连接，则包含对等方的 IPv4/6 地址。

  • peerPort

    数字可选

    如果底层套接字已连接，则包含已连接对等方的端口。

  • socketType

    SocketType

    所传递的套接字的类型。这将是 tcp 或 udp。

SocketType

枚举

"udp"

TLSVersionConstraints

属性

  • 最大值

    字符串（可选）

  • 分钟

    字符串（可选）

    可接受的 TLS 最低和最高版本。支持的值为 tls1.2 或 tls1.3。

    值 tls1 和 tls1.1 不再受支持。如果 min 设为上述任一值，系统会静默地将其强制设为 tls1.2。如果 max 设置为上述任一值或任何其他无法识别的值，则会被静默忽略。

WriteInfo

属性

  • bytesWritten

    number

    已发送的字节数，或负数错误代码。

方法

accept()

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

此方法仅适用于 TCP 套接字。注册一个回调函数，以便在此监听服务器套接字上接受连接时调用。必须先调用 Listen。如果已经有一个有效的接受回调，则系统将立即调用此回调，并以 resultCode 显示错误。

参数

  • socketId

    number

    socketId。

  • callback

    功能

    callback 参数如下所示：

    (acceptInfo: AcceptInfo)=>void

bind()

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

绑定套接字的本地地址。目前不支持 TCP 套接字。

参数

  • socketId

    number

    socketId。

  • 地址

    string

    本地机器的地址。

  • 端口

    number

    本地机器的端口。

  • callback

    功能

    callback 参数如下所示：

    (result: number)=>void

    • 结果

      number

connect()

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

将套接字连接到远程机器（用于 tcp 套接字）。对于 udp 套接字，此设置将为 read() 和 write() 调用设置发送到和读取数据包的默认地址。

参数

  • socketId

    number

    socketId。

  • hostname

    string

    远程计算机的主机名或 IP 地址。

  • 端口

    number

    远程计算机的端口。

  • callback

    功能

    callback 参数如下所示：

    (result: number)=>void

    • 结果

      number

create()

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

创建指定类型的套接字，用于连接到指定远程机器。

参数

  • 类型

    SocketType

    要创建的套接字类型。必须为 tcp 或 udp。

  • 选项

    CreateOptions 可选

    套接字选项。

  • callback

    函数（可选）

    callback 参数如下所示：

    (createInfo: CreateInfo)=>void

返回

  • Promise<CreateInfo>

    Chrome 121 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

destroy()

chrome.socket.destroy(
  socketId: number,
)

销毁套接字。创建的每个套接字都应在使用后销毁。

参数

  • socketId

    number

    socketId。

disconnect()

chrome.socket.disconnect(
  socketId: number,
)

断开套接字。对于 UDP 套接字，disconnect 不可操作，但可以安全调用。

参数

  • socketId

    number

    socketId。

getInfo()

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

检索指定套接字的状态。

参数

  • socketId

    number

    socketId。

  • callback

    函数（可选）

    callback 参数如下所示：

    (result: SocketInfo)=>void

返回

  • Promise<SocketInfo>

    Chrome 121 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getJoinedGroups()

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

获取套接字当前已加入的多播组地址。

参数

  • socketId

    number

    socketId。

  • callback

    功能

    callback 参数如下所示：

    (groups: string[])=>void

    • 组

      字符串[]

getNetworkList()

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

检索有关此系统上本地适配器的信息。

参数

返回

  • Promise<NetworkInterface[]>

    Chrome 121 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

joinGroup()

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

加入多播群组并开始接收来自该群组的数据包。套接字必须为 UDP 类型，并且在调用此方法之前，必须绑定到本地端口。

参数

  • socketId

    number

    socketId。

  • 地址

    string

    要加入的群组地址。不支持域名。

  • callback

    功能

    callback 参数如下所示：

    (result: number)=>void

    • 结果

      number

leaveGroup()

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

退出之前使用 joinGroup 加入的多播组。在销毁套接字或退出之前，无需离开多播组。操作系统自动调用此方法。

离开该组将阻止路由器向本地主机发送多播数据报，假定主机上没有其他进程仍加入该组。

参数

  • socketId

    number

    socketId。

  • 地址

    string

    要退出的群组地址。不支持域名。

  • callback

    功能

    callback 参数如下所示：

    (result: number)=>void

    • 结果

      number

listen()

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

此方法仅适用于 TCP 套接字。监听指定端口和地址上的连接。这有效地使其成为服务器套接字，并且无法再在此套接字上使用客户端套接字函数（连接、读取、写入）。

参数

  • socketId

    number

    socketId。

  • 地址

    string

    本地机器的地址。

  • 端口

    number

    本地机器的端口。

  • 积压

    数字可选

    套接字监听队列的长度。

  • callback

    功能

    callback 参数如下所示：

    (result: number)=>void

    • 结果

      number

read()

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

从已连接的给定套接字中读取数据。

参数

  • socketId

    number

    socketId。

  • bufferSize

    数字可选

    读取缓冲区空间。

  • callback

    功能

    callback 参数如下所示：

    (readInfo: ReadInfo)=>void

recvFrom()

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

从指定的 UDP 套接字接收数据。

参数

  • socketId

    number

    socketId。

  • bufferSize

    数字可选

    接收缓冲区空间。

  • callback

    功能

    callback 参数如下所示：

    (recvFromInfo: RecvFromInfo)=>void

secure()

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

通过已连接的 TCP 客户端套接字启动 TLS 客户端连接。

参数

  • socketId

    number

    要使用的已连接套接字。

  • 选项

    SecureOptions 可选

    TLS 连接的限制和参数。

  • callback

    功能

    callback 参数如下所示：

    (result: number)=>void

    • 结果

      number

sendTo()

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

将给定 UDP 套接字上的数据发送到指定的地址和端口。

参数

  • socketId

    number

    socketId。

  • data

    ArrayBuffer

    要写入的数据。

  • 地址

    string

    远程计算机的地址。

  • 端口

    number

    远程计算机的端口。

  • callback

    功能

    callback 参数如下所示：

    (writeInfo: WriteInfo)=>void

setKeepAlive()

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

启用或停用 TCP 连接的 keep-alive 功能。

参数

  • socketId

    number

    socketId。

  • enable

    boolean

    如果为 true，则启用 keep-alive 功能。

  • delay

    数字可选

    设置接收到的最后一个数据包与第一次 keepalive 探测之间的延迟时间（以秒为单位）。默认值为 0。

  • callback

    功能

    callback 参数如下所示：

    (result: boolean)=>void

    • 结果

      boolean

setMulticastLoopbackMode()

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

设置从主机发送到多播组的多播数据包是否环回主机。

注意：在 Windows 和类似 Unix 的系统之间，setMulticastLoopbackMode 的行为略有不同。只有当同一主机上有多个应用加入同一个多播组，同时在多播环回模式下采用不同的设置时，才会出现不一致的情况。在 Windows 上，已关闭环回功能的应用无法接收环回数据包；而在类似 Unix 的系统上，已关闭环回功能的应用不会将环回数据包发送到同一主机上的其他应用。请访问 MSDN：http://goo.gl/6vqbj

调用此方法不需要多播权限。

参数

  • socketId

    number

    socketId。

  • 已启用

    boolean

    指示是否启用环回模式。

  • callback

    功能

    callback 参数如下所示：

    (result: number)=>void

    • 结果

      number

setMulticastTimeToLive()

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

设置发送到多播组的多播数据包的存留时间。

调用此方法不需要多播权限。

参数

  • socketId

    number

    socketId。

  • ttl

    number

    存留时间值。

  • callback

    功能

    callback 参数如下所示：

    (result: number)=>void

    • 结果

      number

setNoDelay()

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

设置或清除 TCP 连接的 TCP_NODELAY。设置 TCP_NODELAY 后，系统会停用 Nagle 算法。

参数

  • socketId

    number

    socketId。

  • noDelay

    boolean

    如果为 true，则停用 Nagle 的算法。

  • callback

    功能

    callback 参数如下所示：

    (result: boolean)=>void

    • 结果

      boolean

write()

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

在指定的已连接套接字上写入数据。

参数

  • socketId

    number

    socketId。

  • data

    ArrayBuffer

    要写入的数据。

  • callback

    功能

    callback 参数如下所示：

    (writeInfo: WriteInfo)=>void