roomproxy

A simple events boradcast module base on room

#RoomProxy

你若触发,我就广播。

RoomProxy是一个群组事件广播模块。它有几个feature:

  1. 群组在这里被命名为房间(Room),一个房间可以有多个成员(Client)。
  2. Room实现订阅/发布模式,可通过API进行任意事件绑定与发布,触发的事件会广播到Room内每个成员。
  3. 模块只实现Client之间的通知、通讯功能,业务逻辑交还调用者设定。

##使用方法

###引入依赖库###

//groupproxy库
<script src="http://localhost:8080/roomproxy.js"></script>

###创建RoomProxy实例

var proxy = new RoomProxy('http://localhost:3000');

RoomProxy对象在引入的时候会赋予全局对象;初始化需要传入参数为socket连接地址。

###APIs

####RoomProxy

#####joinRoom(string roomName, [string userIds], [function callback])#####

//用法一
proxy.joinRoom('test', function(room){
    //do somethings
});

//用法二
var room = proxy.joinRoom('test2');
//do somethings

#####leaveRoom(string roomName)#####

#####getRoom(string roomName)#####

var room = proxy.getRoom('test');
//do somethings

####Room

#####on(string event, function callback) | emit(string event, JSON data)

var room = proxy.getRoom('test');

//绑定`message`事件
room.on('message', function(err, data){
    if(! err)
        console.log(data); //{roomName: 'test', event: 'message', data: {message: 'hello world'}}
});

//广播触发`message`事件
room.emit('message', {message: 'hello world.'});

#####getInfo(function callback)

暂时只返回'client_ids'.

room.getInfo(function(data){
    console.log(data); //{client_ids: [xxx,yyy,zzz]}
});