Socket.IO 客户端 API Socket

socket.id

会话的唯一标识符。connect事件触发后设置，并在reconnect事件发生后更新。

const socket = io('http://localhost');

console.log(socket.id); // undefined

socket.on('connect', () => {
  console.log(socket.id); // 'G5p5...'
});

socket.connected socket.disconnected

是否连接到服务器

socket.open() socket.connect()

在options选项中的autoConnect 设置为false时，手动连接

也可用在disconnected情况下手动连接

socket.on('disconnect', () => {
  socket.open();
});

socket.send([…args][, ack])

• args
• ack (Function)
• return Socket

触发服务端的'message'事件

socket.emit(eventName[, …args][, ack])

触发服务器端名为eventName的事件

socket.on(eventName, callback)

为给定的eventName注册一个事件

socket.compress(value)

为后续的事件设置修饰符，如果值为ture，则压缩时间数据。默认为true

socket.binary(value)

socket.close() socket.disconnect()

手动断连接

Event: ‘connect’

触发连接事件，包括一个成功的重新连接

Event: ‘connect_error’

Event: ‘connect_timeout’

Event: ‘error’

Event: ‘disconnect’

• reason : 服务器连接断开或客户端连接断开

Event: ‘reconnect’

• attempt: 重新尝试连接次数

Event: ‘reconnect_attempt’

• attempt: 重新尝试连接次数

Event: ‘reconnect_error’

• error: error Object

Event: ‘reconnect_failed’

重新连接失败

Event: ‘ping’

ping数据包发送给服务器触发

Event: 'pong'

• ms： 自ping数据包发送的毫秒数

从服务器接收到pong包时触发