No results for

Powered byAlgolia
⚠️ This is the archived documentation for k6 v0.46. Go to the latest version.

Socket.ping()

A module with a better and standard API exists

The new k6/experimental/websockets API partially implements the WebSockets API living standard.

When possible, we recommend using the new API. It uses a global event loop for consistency with other k6 APIs and better performance.

Send a ping. Ping messages can be used to verify that the remote endpoint is responsive.

Example

import ws from 'k6/ws';
export default function () {
const url = 'ws://echo.websocket.org';
const response = ws.connect(url, null, function (socket) {
socket.on('open', function () {
socket.on('pong', function () {
// As required by the spec, when the ping is received, the recipient must send back a pong.
console.log('connection is alive');
});
socket.ping();
});
});
}