k6/ws
注意
存在一个更好且标准的 API 模块。
新的 k6/experimental/websockets API 部分实现了 WebSockets API Living Standard。
如果可能,我们建议使用新的 API。它使用全局事件循环,与其他 k6 API 保持一致,并提供更好的性能。
k6/ws
模块提供一个实现 WebSocket 协议的 WebSocket 客户端。
函数 | 描述 |
---|---|
connect( url, params, callback ) | 创建一个 WebSocket 连接,并提供一个 Socket 客户端与服务交互。此方法会阻塞测试结束,直到连接关闭。 |
类/方法 | 描述 |
---|---|
Params | 用于设置各种 WebSocket 连接参数,例如头部、cookie jar、压缩等。 |
Socket | 用于与 WS 连接交互的 WebSocket 客户端。 |
Socket.close() | 关闭 WebSocket 连接。 |
Socket.on(event, callback) | 为连接设置以下任何事件的事件监听器 - open - binaryMessage - message - ping - pong - close - error。 |
Socket.ping() | 发送一个 ping。 |
Socket.send(data) | 发送字符串数据。 |
Socket.sendBinary(data) | 发送二进制数据。 |
Socket.setInterval(callback, interval) | 在连接打开时,以一定间隔重复调用函数。 |
Socket.setTimeout(callback, period) | 如果连接打开,延迟调用函数。 |