WebSocket

The WebSocket 類別代表頁面中的 websocket 連線。

---

方法

expect_event

在 v1.9 之前新增 webSocket.expect_event

等待事件觸發並將其值傳遞到 predicate 函數中。當 predicate 返回真值時返回。如果 webSocket 在事件觸發之前關閉，將拋出錯誤。返回事件資料值。

用法

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

參數

• event str#

  事件名稱，與傳遞到 webSocket.on(event) 中的名稱相同。

• predicate Callable (optional)#

  接收事件資料，並在等待應該解析時解析為真值。

• timeout float (optional)#

  等待的最大時間，以毫秒為單位。預設值為 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 函數中，並等待 predicate(event) 返回真值。如果 socket 在 event 觸發之前關閉，將拋出錯誤。

用法

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

參數

• event str#

  事件名稱，通常與傳遞到 *.on(event) 中的名稱相同。

• predicate Callable (optional)#

  接收事件資料，並在等待應該解析時解析為真值。

• timeout float (optional)#

  等待的最大時間，以毫秒為單位。預設值為 30000 (30 秒)。傳遞 0 以停用超時。可以使用 browser_context.set_default_timeout() 更改預設值。

返回

• Any#

---

屬性

is_closed

在 v1.9 之前新增 webSocket.is_closed

表示 web socket 已關閉。

用法

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 接收到 frame 時觸發。

用法

web_socket.on("framereceived", handler)

事件資料

• str | bytes

---

on("framesent")

在 v1.9 中新增 webSocket.on("framesent")

當 websocket 發送 frame 時觸發。

用法

web_socket.on("framesent", handler)

事件資料

• str | bytes

---

on("socketerror")

在 v1.9 中新增 webSocket.on("socketerror")

當 websocket 發生錯誤時觸發。

用法

web_socket.on("socketerror", handler)

事件資料

• str