socket.io系統(tǒng)api
1. 服務(wù)端
io.on('connection',function(socket));
監(jiān)聽(tīng)客戶端連接,回調(diào)函數(shù)會(huì)傳遞本次連接的socket
io.sockets.emit('String',data);
給所有客戶端廣播消息
io.sockets.socket(socketid).emit('String', data);
給指定的客戶端發(fā)送消息
socket.on('String',function(data));
監(jiān)聽(tīng)客戶端發(fā)送的信息
socket.emit('String', data);
給該socket的客戶端發(fā)送消息
廣播消息
//給除了自己以外的客戶端廣播消息
socket.broadcast.emit("msg",{data:"hello,everyone"});
//給所有客戶端廣播消息
io.sockets.emit("msg",{data:"hello,all"});
分組
socket.on('group1', function (data) {
socket.join('group1');
});
socket.on('group2',function(data){
socket.join('group2');
});
客戶端發(fā)送
socket.emit('group1')酝豪,就可以加入group1分組意敛;
socket.emit('group2')耕驰,就可以加入group2分組爷肝;
踢出分組
socket.leave(data.room);
對(duì)分組中的用戶發(fā)送信息
//不包括自己
socket.broadcast.to('group1').emit('event_name', data);
//包括自己
io.sockets.in('group1').emit('event_name', data);
broadcast方法允許當(dāng)前socket client不在該分組內(nèi)
**獲取連接的客戶端socket **
io.sockets.clients().forEach(function (socket) {
//.....
})
獲取分組信息
//獲取所有房間(分組)信息
io.sockets.manager.rooms
//來(lái)獲取此socketid進(jìn)入的房間信息
io.sockets.manager.roomClients[socket.id]
//獲取particular room中的客戶端毙籽,返回所有在此房間的socket實(shí)例
io.sockets.clients('particular room')
另一種分組方式
io.of('/some').on('connection', function (socket) {
socket.on('test', function (data) {
socket.broadcast.emit('event_name',{});
});
});
客戶端
var socket = io.connect('ws://103.31.201.154:5555/some')
socket.on('even_name',function(data){
console.log(data);
})
客戶端都鏈接到ws://103.31.201.154:5555 但是服務(wù)端可以通過(guò)io.of('/some')將其過(guò)濾出來(lái)奋渔。
另外张足,Socket.IO提供了4個(gè)配置的API:io.configure, io.set, io.enable, io.disable笨枯。其中io.set對(duì)單項(xiàng)進(jìn)行設(shè)置蛙讥,io.enable和io.disable用于單項(xiàng)設(shè)置布爾型的配置锯蛀。io.configure 可以讓你對(duì)不同的生產(chǎn)環(huán)境(如devlopment,test等等)配置不同的參數(shù)次慢。
2. 客戶端
建立一個(gè)socket連接
var socket = io("ws://103.31.201.154:5555");
監(jiān)聽(tīng)服務(wù)消息
socket.on('msg',function(data){
socket.emit('msg', {rp:"fine,thank you"}); //向服務(wù)器發(fā)送消息
console.log(data);
});
socket.on("String",function(data)) 監(jiān)聽(tīng)服務(wù)端發(fā)送的消息 Sting參數(shù)與服務(wù)端emit第一個(gè)參數(shù)相同
監(jiān)聽(tīng)socket斷開(kāi)與重連
socket.on('disconnect', function() {
console.log("與服務(wù)其斷開(kāi)");
});
socket.on('reconnect', function() {
console.log("重新連接到服務(wù)器");
});
客戶端socket.on()監(jiān)聽(tīng)的事件:
connect:連接成功
connecting:正在連接
disconnect:斷開(kāi)連接
connect_failed:連接失敗
error:錯(cuò)誤發(fā)生旁涤,并且無(wú)法被其他事件類型所處理
message:同服務(wù)器端message事件
anything:同服務(wù)器端anything事件
reconnect_failed:重連失敗
reconnect:成功重連
reconnecting:正在重連
當(dāng) 第一次連接時(shí),事件觸發(fā)順序?yàn)椋篶onnecting->connect迫像;當(dāng)失去連接時(shí)劈愚,事件觸發(fā)順序 為:disconnect->reconnecting(可能進(jìn)行多 次)->connecting->reconnect->connect。