Pomelo开发中Web客户端开发API简介

本文主要是介绍Pomelo开发中Web客户端开发API简介，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

转载自： http://zhuxianzhong.blog.51cto.com/157061/1615109

使用pomelo做服务端开发时，无论什么客户端，只要能遵循与服务端的线上协议，就能够与服务端建立通信。pomelo内建提供的sioconnector和hybridconnector都定义了自己的协议格式，其中sioconnector用于socket.io的通信，hybridconnector则用来处理websocket和tcp的连接通信。为了方便客户端的开发，pomelo提供了部分平台的客户端SDK，主要包括用于Web端的JavaScript的SDK以及基于C/C++语言开发的libpomelo的使用。

【补充】hybrid意思是杂交，在此hybridconnector是指高级connector。我们知道，connector在pomelo架构中负责承担与客户端的网络通信任务。为了理解hybrid一词，看一个小故事：带有HYBRID标识的车型，都是指混合动力汽车，即有内燃机和电力混合驱动的车辆；显然这类车是指同类车中的高级型。新型浏览器都会支持HTML5格式网页设计，自然hybridconnector对应用来处理 websocket（新一代）和tcp类型的连接通信。

Web端JavaScript开发库

对于浏览器来说，HTML5中已经支持了websocket，因此使用支持websocket的浏览器可以直接与服务端的hybridconnector建立通信。而对于比较旧的浏览器来说，还没有支持websocket的，可以使用基于socket.io的方式进行与服务端建立连接。因此，对于Web 端，pomelo提供了两套开发库，分别适用于支持websocket的浏览器和不支持websocket的浏览器，这两套开发库的链接如下，适用于 socket.io的pomelo-jsclient-socket.io以及适用于websocket的pomelo-jsclient- websocket。

web端API简介

无论是socket.io的还是websocket的，都提供了统一的API，下面对这些API进行简单的介绍。

pomelo.init(params, cb)
这是往往是客户端的第一次调用，params中应该指出要连接的服务器的ip和端口号，cb会在连接成功后进行回调;
pomelo.request(route, msg, cb)
请求服务，route为服务端的路由，格式为"..", msg为请求的内容，cb会响应回来后的回调;
pomelo.notify(route, msg)
发送notify，不需要服务器回响应的，因此没有对响应的回调，其他参数含义同request;
pomelo.on(route, cb)
这个是从EventEmmiter继承过来的方法，用来对服务端的推送作出响应的。route会用户自定义的，格式一般为"onXXX";
pomelo.disconnect()
这个是pomelo主动断开连接的方法。

chatofpomelo-websocket实例客户端相关代码

网易的chatofpomelo-websocket示例尽管展示了一个简单的基于客户端浏览器的聊天网络程序，但是对于理解POMELO架构具有重要意义。下面，我们简单列举出客户端关键脚本client.js中相应于上面的API相关代码。

  function  queryEntry(uid, callback) { 
   var  route =  'gate.gateHandler.queryEntry' ; 
   pomelo.init({ 
    host: window.location.hostname, 
    port: 3014, 
    log:  true 
   },  function () { 
    pomelo.request(route, { 
     uid: uid 
    },  function (data) { 
     pomelo.disconnect(); 
     if (data.code === 500) { 
      showError(LOGIN_ERROR); 
      return ; 
     } 
     callback(data.host, data.port); 
    }); 
   }); 
 }; 
 

   pomelo.on( 'onChat' ,  function (data) { 
    addMessage(data.from, data.target, data.msg); 
    $( "#chatHistory" ).show(); 
    if (data.from !== username) 
     tip( 'message' , data.from); 
   }); 
   。 