主要コンテンツにスキップ

WebSocket

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

WebSocketフレームを傍受または変更したい場合は、WebSocketRoute の使用を検討してください。

メソッド​

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() を使用して変更できます。

戻り値

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() を使用して変更できます。

戻り値

プロパティ​

is_closed​

v1.9以前に追加 webSocket.is_closed

ウェブソケットが閉じられたことを示します。

使用法

web_socket.is_closed()

戻り値

url​

v1.9以前に追加 webSocket.url

WebSocketのURLを含みます。

使用法

web_socket.url

戻り値

イベント​

on("close")​

v1.9以前に追加 webSocket.on("close")

ウェブソケットが閉じられたときに発生します。

使用法

web_socket.on("close", handler)

イベントデータ

on("framereceived")​

追加されたバージョン: v1.9 webSocket.on("framereceived")

ウェブソケットがフレームを受信したときに発生します。

使用法

web_socket.on("framereceived", handler)

イベントデータ

on("framesent")​

追加されたバージョン: v1.9 webSocket.on("framesent")

ウェブソケットがフレームを送信したときに発生します。

使用法

web_socket.on("framesent", handler)

イベントデータ

on("socketerror")​

追加されたバージョン: v1.9 webSocket.on("socketerror")

ウェブソケットでエラーが発生したときに発生します。

使用法

web_socket.on("socketerror", handler)

イベントデータ