WebSocket

WebSocket クラスは、ページ内の WebSocket 接続を表します。送信および受信されるデータを検査および操作する機能を提供します。

WebSocket フレームをインターセプトまたは変更する場合は、WebSocketRoute の使用を検討してください。

---

メソッド

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 (オプション)#

  イベントデータを受け取り、待機が解決されるべきときに真の値を解決します。

• 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 関数に渡し、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