Browser端参考手册

Browser参考手册

Notice: 自v0.5.3起, 两个前端依赖库event.js和rocken.js将会在RocketEngine实例bind到HTTP Server时自动将路由规则GET /event.js和GET /rocken.js挂载到原有HTTP 路由之前. 也就是说你可以直接在客户端里写这样的代码<script src="/event.js">而无需对Http服务器代码做任何修改.

这部分是浏览器上的RocketEngine框架的详细使用说明。浏览器端的rocken依赖event.js模块。event.js为其提供了Custome-DOM事件驱动。

• rocken对象
  • rocken.connect方法 @ws_url，@callback
    连接到fslider服务器
  • rocken.emit方法 继承自event.js提供的EventEmitter.emit
    触发系统级事件
  • rocken.on方法 继承自event.js提供的EventEmitter.emit
    监听系统级事件
  • rocken.ref属性 页面中所有websocket连接的重连计时器的引用
• socket对象
  • socket.url属性 fslider服务器的url
  • socket.cb属性 connect事件回调函数
  • socket.expire属性 重新连接的等待时间（ms）
  • socket.id属性 系统分配给每个socket的唯一标识
  • socket.autoreconnect属性 是否自动重连
  • socket.sysEmit方法 继承自event.js提供的EventEmitter.emit
    触发系统级事件
  • socket.emit方法 @event，@data 覆盖event.js提供的EventEmitter.emit
    向服务器发送event
  • socket.on方法 监听来自服务器的事件
  • socket.send方法 socket.emit('date', data)的语法糖。
  • socket.recive方法 socket.on('data', callback)的语法糖。
  • socket.close方法 [@code]
    发送关闭连接请求。

System-Level Events

Note：应用程序里定义的事件名称尽量不要与这些预定义的事件名称冲突

• rocken
  • #disconnect 回调参数：client。
    （全局）有连接与服务器断开时触发。
• socket
  • #open 回调参数：client。
    连接成功建立时触发。
  • #close 回调参数：close_info。
    连接关闭时触发。
  • #error 回调参数：error。 当连接中发生错误时触发。