WebSocket

WebSocket 类代表页面中的 websocket 连接。

---

方法

expect_event

在 v1.9 版本之前添加 webSocket.expect_event

等待事件触发，并将其值传递给谓词函数。当谓词返回真值时返回。如果 webSocket 在事件触发之前关闭，将抛出错误。返回事件数据值。

用法

web_socket.expect_event(event)
web_socket.expect_event(event, **kwargs)

参数

• event str#

  事件名称，与传递到 webSocket.on(event) 中的名称相同。

• predicate Callable (可选)#

  接收事件数据，并在等待应该解决时解析为真值。

• timeout float (可选)#

  等待的最大时间，以毫秒为单位。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 来更改。

返回值

• EventContextManager#

---

wait_for_event

在 v1.9 版本之前添加 webSocket.wait_for_event

注意

在大多数情况下，您应该使用 web_socket.expect_event()。

等待给定的 event 触发。如果提供了谓词，它会将事件的值传递给 predicate 函数，并等待 predicate(event) 返回真值。如果套接字在 event 触发之前关闭，将抛出错误。

用法

web_socket.wait_for_event(event)
web_socket.wait_for_event(event, **kwargs)

参数

• event str#

  事件名称，通常与传递到 *.on(event) 中的名称相同。

• predicate Callable (可选)#

  接收事件数据，并在等待应该解决时解析为真值。

• timeout float (可选)#

  等待的最大时间，以毫秒为单位。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 来更改。

返回值

• Any#

---

属性

is_closed

在 v1.9 版本之前添加 webSocket.is_closed

指示 websocket 是否已关闭。

用法

web_socket.is_closed()

返回值

• bool#

---

url

在 v1.9 版本之前添加 webSocket.url

包含 WebSocket 的 URL。

用法

web_socket.url

返回值

• str#

---

事件

on("close")

在 v1.9 版本之前添加 webSocket.on("close")

当 websocket 关闭时触发。

用法

web_socket.on("close", handler)

事件数据

• WebSocket

---

on("framereceived")

添加于: v1.9 webSocket.on("framereceived")

当 websocket 接收到帧时触发。

用法

web_socket.on("framereceived", handler)

事件数据

• str | bytes

---

on("framesent")

添加于: v1.9 webSocket.on("framesent")

当 websocket 发送帧时触发。

用法

web_socket.on("framesent", handler)

事件数据

• str | bytes

---

on("socketerror")

添加于: v1.9 webSocket.on("socketerror")

当 websocket 发生错误时触发。

用法

web_socket.on("socketerror", handler)

事件数据

• str