跳到主要内容

WebSocket

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

如果您想拦截或修改 WebSocket 帧，请考虑使用 WebSocketRoute。

方法​

isClosed​

在 v1.9 之前添加 webSocket.isClosed

表示 web socket 是否已关闭。

用法

WebSocket.isClosed();

返回值

url​

在 v1.9 之前添加 webSocket.url

包含 WebSocket 的 URL。

用法

WebSocket.url();

返回值

waitForFrameReceived​

添加于: v1.10 webSocket.waitForFrameReceived

执行操作并等待接收帧。如果提供了 predicate，它会将 WebSocketFrame 值传递到 predicate 函数中，并等待 predicate(webSocketFrame) 返回真值。如果在接收到帧之前 WebSocket 或 Page 关闭，将抛出错误。

用法

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

参数

  • options WebSocket.WaitForFrameReceivedOptions (可选)

  • callback Runnable添加于: v1.9#

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

返回值

waitForFrameSent​

添加于: v1.10 webSocket.waitForFrameSent

执行操作并等待发送帧。如果提供了 predicate，它会将 WebSocketFrame 值传递到 predicate 函数中，并等待 predicate(webSocketFrame) 返回真值。如果在发送帧之前 WebSocket 或 Page 关闭，将抛出错误。

用法

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

参数

  • options WebSocket.WaitForFrameSentOptions (可选)

  • callback Runnable添加于: v1.9#

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

返回值

事件​

onClose(handler)​

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

当 websocket 关闭时触发。

用法

WebSocket.onClose(handler)

事件数据

onFrameReceived(handler)​

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

当 websocket 接收到帧时触发。

用法

WebSocket.onFrameReceived(handler)

事件数据

onFrameSent(handler)​

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

当 websocket 发送帧时触发。

用法

WebSocket.onFrameSent(handler)

事件数据

onSocketError(handler)​

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

当 websocket 发生错误时触发。

用法

WebSocket.onSocketError(handler)

事件数据