菜单
文档breadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/experimentalbreadcrumb arrow websocketsbreadcrumb arrow WebSocket
开源 RSS

WebSocket

创建 WebSocket 实例用于连接到远程主机。

以下事件可能导致连接关闭

  • 远程主机关闭事件。
  • WebSocket.close().
  • 基于测试配置或 CLI 命令的 k6 虚拟用户 (VU) 中断。
参数类型描述
url字符串要连接的 URL（例如，“ws://:10000”）。
protocols数组尚未实现，保留供将来使用。
params对象Params 对象，包含额外请求参数。

返回值

类型描述
WebSocket一个 WebSocket 对象实例。

示例

一个初始化 WebSocket 连接的 k6 脚本。

JavaScript 
import { WebSocket } from 'k6/experimental/websockets';

export default function () {
  const ws = new WebSocket('ws://:10000');

  ws.onopen = () => {
    console.log('WebSocket connection established!');
    ws.close();
  };
}

前面的示例使用了一个 WebSocket Echo 服务器，您可以使用以下命令运行它

bash 
docker run --detach --rm --name ws-echo-server -p 10000:8080 jmalloc/echo-server