tencent cloud

All product documents
Tencent Cloud Observability Platform
DocumentationTencent Cloud Observability PlatformPerformance Testing ServiceJavaScript API Listpts/socketiosocketiosocketio.on
socketio.on
Download PDF
Last updated: 2025-03-11 20:31:03
socketio.on
Last updated: 2025-03-11 20:31:03
Download PDF
socketio.on listens for messages events. 
on(event: string, callback: (...args: any[]) => void): void

Parameters

Parameter
Type
Description
event
string
Event.
callback
function
Callback function.

Return

Type
Description
void
No content returned.

Samples

// SocketIO API
import socketio from 'pts/socketio';
import { check, sleep } from 'pts';
import util  from 'pts/util';

export default function () {
  const res = socketio.connect('http://localhost:8080', function (socket) {
    socket.on('open', () => console.log('connected'));
    socket.on('message', (data) => console.log('message received: ', data));
    socket.on('binaryMessage', (data) => console.log('binaryMessage received: ', data));
    socket.on('close', () => console.log('disconnected'));
    socket.setTimeout(function () {
      console.log('3 seconds passed, closing the socket');
      socket.close();
    }, 3000);
    // Set the scheduled task.
    socket.setTimeout(function () {
      socket.emit('message', 'hello');
      socket.emit('binaryMessage', util.base64Decoding('aGVsbG8=', 'std', 'b'));
      socket.emit('ackMessage',  'hello ack', function(msg) {
        console.log('ack message received: ', msg)
      })
    }, 500);
    // Set the periodic task.
    socket.setInterval(function(){
      socket.emit('message', 'interval message');
    }, 500);
    // Set up a loop to execute tasks, and socket/context will close and naturally exit.
    socket.setLoop(function () {
      sleep(0.1);
      socket.emit('message', 'loop message');
    });
  }, {
    // Support polling and WebSocket protocols.
    protocol:'websocket',
    headers: {
      token: 'xxx',
    }
  });
  check('status is 200', () => res.status === 200);
}

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon