WebSocket

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

---

方法

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

执行操作并等待发送帧。如果提供了 predicate，它会将 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