WebSocket

WebSocket 类表示页面内的 WebSocket 连接。它提供了检查和操作传输及接收数据的能力。

如果你想拦截或修改 WebSocket 帧，可以考虑使用 WebSocketRoute。

---

方法

isClosed

在 v1.9 之前添加 webSocket.isClosed

表示 WebSocket 已关闭。

用法

WebSocket.isClosed();

返回值

• boolean#

---

url

在 v1.9 之前添加 webSocket.url

包含 WebSocket 的 URL。

用法

WebSocket.url();

返回值

• String#

---

waitForFrameReceived

添加于：v1.10 webSocket.waitForFrameReceived

执行操作并等待发送一个帧。如果提供了断言函数 predicate，它会将 WebSocketFrame 值传入 predicate 函数，并等待 predicate(webSocketFrame) 返回真值。如果在接收到帧之前 WebSocket 或页面关闭，则会抛出错误。

用法

WebSocket.waitForFrameReceived(callback);
WebSocket.waitForFrameReceived(callback, options);

参数

• options WebSocket.WaitForFrameReceivedOptions（可选）

  • setPredicate Predicate<WebSocketFrame>（可选）新增于：v1.9#

    接收 WebSocketFrame 对象，当等待条件满足时解析为真值。

  • setTimeout double（可选）新增于：v1.9#

    最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可通过 BrowserContext.setDefaultTimeout() 更改。

• callback Runnable 新增于：v1.9#

  执行触发事件操作的回调。

返回值

• WebSocketFrame#

---

waitForFrameSent

新增于：v1.10 webSocket.waitForFrameSent

执行操作并等待发送一个帧。如果提供了断言函数，它会将 WebSocketFrame 值传入 predicate 函数，并等待 predicate(webSocketFrame) 返回真值。如果在发送帧之前 WebSocket 或页面关闭，则会抛出错误。

用法

WebSocket.waitForFrameSent(callback);
WebSocket.waitForFrameSent(callback, options);

参数

• options WebSocket.WaitForFrameSentOptions (可选)

  • setPredicate Predicate<WebSocketFrame> (可选) 新增于：v1.9#

    接收 WebSocketFrame 对象，当等待条件满足时解析为真值。

  • setTimeout double (可选) 新增于：v1.9#

    最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 更改。

• callback Runnable 新增于：v1.9#

  执行触发事件操作的回调函数。

返回值

• WebSocketFrame#

---

事件

onClose(handler)

在 v1.9 之前添加 webSocket.onClose(handler)

在 WebSocket 关闭时触发。

用法

WebSocket.onClose(handler)

事件数据

• WebSocket

---

onFrameReceived(handler)

添加于：v1.9 webSocket.onFrameReceived(handler)

在 WebSocket 接收到一个帧时触发。

用法

WebSocket.onFrameReceived(handler)

事件数据

• WebSocketFrame

---

onFrameSent(handler)

添加于：v1.9 webSocket.onFrameSent(handler)

在 WebSocket 发送一个帧时触发。

用法

WebSocket.onFrameSent(handler)

事件数据

• WebSocketFrame

---

onSocketError(handler)

添加于：v1.9 webSocket.onSocketError(handler)

在 WebSocket 发生错误时触发。

用法

WebSocket.onSocketError(handler)

事件数据

• String