服务端
| API | 描述 |
|---|---|
io |
表示 Socket.io 实例，用于管理连接和发送事件。 |
io.on(event, callback) |
监听事件，当客户端触发指定事件时触发回调函数。 |
io.emit(event, data) |
发送事件和数据到所有已连接的客户端。 |
socket |
表示客户端的 Socket 实例，用于管理客户端连接和发送事件。 |
socket.emit(event, data) |
发送事件和数据到连接的客户端。 |
socket.on(event, callback) |
监听事件，当客户端触发指定事件时触发回调函数。 |
socket.join(room) |
将客户端加入指定的房间。 |
socket.leave(room) |
将客户端离开指定的房间。 |
socket.broadcast.emit(event, data) |
发送事件和数据到除了当前连接的客户端之外的所有客户端。 |
io.to(room).emit(event, data) |
发送事件和数据到指定的房间内的所有客户端。 |
房间的常见方法
| 方法 | 描述 |
|---|---|
rooms |
返回一个包含所有已连接的 socket 实例的房间列表。 |
socket.join(room[, callback]) |
将指定的 socket 实例加入指定的房间。可选的回调函数会在加入房间成功后执行。 |
socket.leave(room[, callback]) |
将指定的 socket 实例离开指定的房间。可选的回调函数会在离开房间成功后执行。 |
socket.rooms |
返回一个包含指定 socket 实例加入的所有房间的列表。 |
io.sockets.adapter.rooms[room] |
返回一个包含指定房间内所有 socket 实例的 ID 的对象。 |
客户端
| 方法 | 描述 |
|---|---|
io.connect(url[, options]) |
连接到指定 URL 的 Socket.io 服务器。可选的选项参数包括 forceNew、reconnection、timeout 等。 |
socket.emit(event, data[, callback]) |
向服务器发送指定事件和数据。可选的回调函数会在服务器端响应后执行。 |
socket.on(event, callback) |
监听服务器发送的指定事件。当服务器发送事件时，将会触发指定的回调函数。 |
socket.off([event[, callback]]) |
取消监听指定事件。如果没有指定事件和回调函数，则会取消所有事件的监听。 |
socket.disconnect([close]) |
关闭客户端与服务器之间的连接。可选的参数 close 指定连接是否应该关闭。 |
socket.rooms |
返回一个数组，其中包含当前 socket 实例加入的所有房间。 |