WebSocket

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

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

方法​

isClosed​

表示WebSocket连接已关闭。

用法

WebSocket.isClosed();

返回

• boolean#

网址​

包含WebSocket的URL。

用法

WebSocket.url();

返回

• String#

waitForFrameReceived​

执行操作并等待接收一个帧。如果提供了谓词函数，会将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​

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

用法

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)​

当websocket关闭时触发。

用法

WebSocket.onClose(handler)

事件数据

• WebSocket

onFrameReceived(handler)​

当websocket接收到帧时触发。

用法

WebSocket.onFrameReceived(handler)

事件数据

• WebSocketFrame

onFrameSent(handler)​

当WebSocket发送帧时触发。

用法

WebSocket.onFrameSent(handler)

事件数据

• WebSocketFrame

onSocketError(处理程序)​

当websocket发生错误时触发。

用法

WebSocket.onSocketError(handler)

事件数据

• String