socket.io 系統API

SOCKET.IO，系統API，

原文：http://www.cnblogs.com/xiezhengcai/p/3956401.html 

1. 服務端

io.on('connection',function(socket));

監聽客戶端鏈接,回調函數會傳遞本次鏈接的socket

io.sockets.emit('String',data);

給全部客戶端廣播消息

io.sockets.socket(socketid).emit('String', data);

給指定的客戶端發送消息

socket.on('String',function(data));

監聽客戶端發送的信息

socket.emit('String', data);

給該socket的客戶端發送消息

 

廣播消息

//給除了本身之外的客戶端廣播消息
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');
 });

客戶端發送

socket.emit('group1')，就能夠加入group1分組；
socket.emit('group2')，就能夠加入group2分組；

一個客戶端能夠存在多個分組（訂閱模式）

踢出分組

socket.leave(data.room);

對分組中的用戶發送信息

//不包括本身
socket.broadcast.to('group1').emit('event_name', data);
//包括本身
io.sockets.in('group1').emit('event_name', data);

broadcast方法容許當前socket client不在該分組內

獲取鏈接的客戶端socket 

io.sockets.clients().forEach(function (socket) {
    //.....
})

 

獲取分組信息

//獲取全部房間（分組）信息
io.sockets.manager.rooms
//來獲取此socketid進入的房間信息
io.sockets.manager.roomClients[socket.id]
//獲取particular room中的客戶端，返回全部在此房間的socket實例
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 可是服務端能夠經過io.of('/some')將其過濾出來。

 

另外，Socket.IO提供了4個配置的API：io.configure, io.set, io.enable, io.disable。其中io.set對單項進行設置，io.enable和io.disable用於單項設置布爾型的配置。io.configure可讓你對不一樣的生產環境（如devlopment，test等等）配置不一樣的參數。

2. 客戶端

創建一個socket鏈接

var socket = io("ws://103.31.201.154:5555");

監聽服務消息

socket.on('msg',function(data){
    socket.emit('msg', {rp:"fine,thank you"}); //向服務器發送消息
    console.log(data);
});

socket.on("String",function(data)) 監聽服務端發送的消息 Sting參數與服務端emit第一個參數相同

 

監聽socket斷開與重連。

socket.on('disconnect', function() {
    console.log("與服務其斷開");
});


socket.on('reconnect', function() {
    console.log("從新鏈接到服務器");
});

 

客戶端socket.on()監聽的事件：

connect：鏈接成功
connecting：正在鏈接
disconnect：斷開鏈接
connect_failed：鏈接失敗
error：錯誤發生，而且沒法被其餘事件類型所處理
message：同服務器端message事件
anything：同服務器端anything事件
reconnect_failed：重連失敗
reconnect：成功重連
reconnecting：正在重連
當第一次鏈接時，事件觸發順序爲：connecting->connect；當失去鏈接時，事件觸發順序爲：disconnect->reconnecting（可能進行屢次）->connecting->reconnect->connect。

知識是咱們已知的 也是咱們未知的 基於已有的知識之上 咱們去發現未知的 由此,知識獲得擴充 咱們得到的知識越多 未知的知識就會更多 於是,知識擴充永無止境