WebSocket是HTML5开始提供的一种浏览器与服务器间进行全双工通讯的网络技术。在WebSocket API中,浏览器和服务器只需要做一个握手的动作,然后,浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。

Cocos2d-x引擎集成libwebsockets,并在libwebsockets的客户端API基础上封装了一层易用的接口,使得引擎在C++, JS, Lua层都能方便的使用WebSocket来进行游戏网络通讯。

首先需要include WebSocket的头文件。
  1. #include "network/WebSocket.h"
 
cocos2d::network::WebSocket::Delegate定义了使用WebScocket需要监听的回调通知接口。使用WebSocket的类,需要public继承这个Delegate。 
  1. class WebSocketTestLayer : public cocos2d::Layer, public cocos2d::network::WebSocket::Delegate
 
并Override下面的4个接口:
  1. virtual void onOpen(cocos2d::network::WebSocket* ws);
  2. virtual void onMessage(cocos2d::network::WebSocket* ws, const cocos2d::network::WebSocket::Data& data);
  3. virtual void onClose(cocos2d::network::WebSocket* ws);
  4. virtual void onError(cocos2d::network::WebSocket* ws, const cocos2d::network::WebSocket::ErrorCode& error);
 
后面我们再详细介绍每个回调接口的含义。
新建WebSocket并初始化
WebSocket.org 提供了一个专门用来测试WebSocket的服务器"ws://echo.websocket.org"。 测试代码以链接这个服务器为例,展示如何在Cocos2d-x中使用WebSocket。
 
新建一个WebSocket:
  1. cocos2d::network::WebSocket* _wsiSendText = new network::WebSocket();
 
init第一个参数是delegate,设置为this,第二个参数是服务器地址。 URL中的"ws://"标识是WebSocket协议,加密的WebSocket为"wss://".
  1. _wsiSendText->init(*this, "ws://echo.websocket.org")
 
WebSocket消息监听
在调用send发送消息之前,先来看下4个消息回调。
 
onOpen
init会触发WebSocket链接服务器,如果成功,WebSocket就会调用onOpen,告诉调用者,客户端到服务器的通讯链路已经成功建立,可以收发消息了。
  1. void WebSocketTestLayer::onOpen(network::WebSocket* ws)
  2. {
  3. if (ws == _wsiSendText)
  4. {
  5. _sendTextStatus->setString("Send Text WS was opened.");
  6. }
  7. }
 
onMessage
network::WebSocket::Data对象存储客户端接收到的数据, isBinary属性用来判断数据是二进制还是文本,len说明数据长度,bytes指向数据。
  1. void WebSocketTestLayer::onMessage(network::WebSocket* ws, const network::WebSocket::Data& data)
  2. {
  3. if (!data.isBinary)
  4. {
  5. _sendTextTimes++;
  6. char times[100] = {0};
  7. sprintf(times, "%d", _sendTextTimes);
  8. std::string textStr = std::string("response text msg: ")+data.bytes+", "+times;
  9. log("%s", textStr.c_str());
  10. _sendTextStatus->setString(textStr.c_str());
  11. }
  12. }
 
onClose
不管是服务器主动还是被动关闭了WebSocket,客户端将收到这个请求后,需要释放WebSocket内存,并养成良好的习惯:置空指针。
  1. void WebSocketTestLayer::onClose(network::WebSocket* ws)
  2. {
  3. if (ws == _wsiSendText)
  4. {
  5. _wsiSendText = NULL;
  6. }
  7. CC_SAFE_DELETE(ws);
  8. }
 
onError
客户端发送的请求,如果发生错误,就会收到onError消息,游戏针对不同的错误码,做出相应的处理。
  1. void WebSocketTestLayer::onError(network::WebSocket* ws, const network::WebSocket::ErrorCode& error)
  2. {
  3. log("Error was fired, error code: %d", error);
  4. if (ws == _wsiSendText)
  5. {
  6. char buf[100] = {0};
  7. sprintf(buf, "an error was fired, code: %d", error);
  8. _sendTextStatus->setString(buf);
  9. }
  10. }
 
send消息到服务器
在init之后,我们就可以调用send接口,往服务器发送数据请求。send有文本和二进制两中模式。
 
发送文本
  1. _wsiSendText->send("Hello WebSocket, I'm a text message.");
 
发送二进制数据(多了一个len参数)
  1. _wsiSendBinary->send((unsigned char*)buf, sizeof(buf));
 
主动关闭WebSocket
这是让整个流程变得完整的关键步骤, 当某个WebSocket的通讯不再使用的时候,我们必须手动关闭这个WebSocket与服务器的连接。close会触发onClose消息,而后onClose里面,我们释放内存。
  1. _wsiSendText->close();
 
在Lua中使用
详细代码可参考引擎目录下的/samples/Lua/TestLua/Resources/luaScript/ExtensionTest/WebProxyTest.lua文件。
 
创建WebSocket对象
脚本接口相对C++要简单很多,没有头文件,创建WebSocket对象使用下面的一行代码搞定。 参数是服务器地址。
  1. wsSendText = WebSocket:create("ws://echo.websocket.org")
 
定义并注册消息回调函数
回调函数是普通的Lua function,4个消息回调和c++的用途一致,参考上面的说明。
  1. local function wsSendTextOpen(strData)
  2. sendTextStatus:setString("Send Text WS was opened.")
  3. end
  4. local function wsSendTextMessage(strData)
  5. receiveTextTimes= receiveTextTimes + 1
  6. local strInfo= "response text msg: "..strData..", "..receiveTextTimes
  7. sendTextStatus:setString(strInfo)
  8. end
  9. local function wsSendTextClose(strData)
  10. print("_wsiSendText websocket instance closed.")
  11. sendTextStatus = nil
  12. wsSendText = nil
  13. end
  14. local function wsSendTextError(strData)
  15. print("sendText Error was fired")
  16. end
 
Lua的消息注册不同于C++的继承 & Override,有单独的接口registerScriptHandler。 registerScriptHandler第一个参数是回调函数名,第二个参数是回调类型。 每一个WebSocket实例都需要绑定一次。
  1. if nil ~= wsSendText then
  2. wsSendText:registerScriptHandler(wsSendTextOpen,cc.WEBSOCKET_OPEN)
  3. wsSendText:registerScriptHandler(wsSendTextMessage,cc.WEBSOCKET_MESSAGE)
  4. wsSendText:registerScriptHandler(wsSendTextClose,cc.WEBSOCKET_CLOSE)
  5. wsSendText:registerScriptHandler(wsSendTextError,cc.WEBSOCKET_ERROR)
  6. end
 
send消息
Lua中发送不区分文本或二进制模式,均使用下面的接口。
  1. wsSendText:sendString("Hello WebSocket中文, I'm a text message.")
 
主动关闭WebSocket
当某个WebSocket的通讯不再使用的时候,我们必须手动关闭这个WebSocket与服务器的连接,以释放服务器和客户端的资源。close会触发cc.WEBSOCKET_CLOSE消息。
  1. wsSendText:close()
 
在JSB中使用
详细代码可参考引擎目录下的/samples/Javascript/Shared/tests/ExtensionsTest/NetworkTest/WebSocketTest.js文件。
 
创建WebSocket对象
脚本接口相对C++要简单很多,没有头文件,创建WebSocket对象使用下面的一行代码搞定。 参数是服务器地址。
  1. this._wsiSendText = new WebSocket("ws://echo.websocket.org");
 
设置消息回调函数
JSB中的回调函数是WebSocket实例的属性,使用匿名函数直接赋值给对应属性。可以看出JS语言的特性,让绑定回调函数更加优美。四个回调的含义,参考上面c++的描述。
  1. this._wsiSendText.onopen = function(evt) {
  2. self._sendTextStatus.setString("Send Text WS was opened.");
  3. };
  4. this._wsiSendText.onmessage = function(evt) {
  5. self._sendTextTimes++;
  6. var textStr = "response text msg: "+evt.data+", "+self._sendTextTimes;
  7. cc.log(textStr);
  8. self._sendTextStatus.setString(textStr);
  9. };
  10. this._wsiSendText.onerror = function(evt) {
  11. cc.log("sendText Error was fired");
  12. };
  13. this._wsiSendText.onclose = function(evt) {
  14. cc.log("_wsiSendText websocket instance closed.");
  15. self._wsiSendText = null;
  16. };
 
send消息
发送文本,无需转换,代码如下:
  1. this._wsiSendText.send("Hello WebSocket中文, I'm a text message.");
 
发送二进制,测试代码中,使用_stringConvertToArray函数来转换string为二进制数据,模拟二进制的发送。 new Uint16Array创建一个16位无符号整数值的类型化数组,内容将初始化为0。然后,循环读取字符串的每一个字符的Unicode编码,并存入 Uint16Array,最终得到一个二进制对象。
  1. _stringConvertToArray:function (strData) {
  2. if (!strData)
  3. return null;
  4. var arrData = new Uint16Array(strData.length);
  5. for (var i = 0; i < strData.length; i++) {
  6. arrData[i] = strData.charCodeAt(i);
  7. }
  8. return arrData;
  9. },
 
send二进制接口和send文本没有区别,区别在于传入的对象,JS内部自己知道对象是文本还是二进制数据,然后做不同的处理。
  1. var buf = "Hello WebSocket中文,\0 I'm\0 a\0 binary\0 message\0.";
  2. var binary = this._stringConvertToArray(buf);
  3. this._wsiSendBinary.send(binary.buffer);
 
主动关闭WebSocket
当某个WebSocket的通讯不再使用的时候,我们必须手动关闭这个WebSocket与服务器的连接,以释放服务器和客户端的资源。close会触发onclose消息。
  1. onExit: function() {
  2. if (this._wsiSendText)
  3. this._wsiSendText.close();
  4. },

转自:http://blog.sina.com.cn/s/blog_923fdd9b0101ggao.html

cocos2d-x WebSocket的更多相关文章

  1. Cocos2d-X网络编程(3) Cocos2d中的网络通信协议——WebSocket协议

    WebSocket protocol 是HTML5一种新的协议.它实现了浏览器与服务器全双工通信.实现浏览器与服务器的即时通讯.即服务器也能主动向客户端发消息. WebSocket代理类和方法: co ...

  2. 【转】【cocos2d-x教程】如何使用WebSocket

    介绍 WebSocket是HTML5开始提供的一种浏览器与服务器间进行全双工通讯的网络技术.在WebSocket API中,浏览器和服务器只需要做一个握手的动作,然后,浏览器和服务器之间就形成了一条快 ...

  3. [Cocos2d-x]在Cocos2d-x 3.x如何通过版本号WebSocket连接server数据的传输

    WebSocket 首先新建一个空的目录,通过npm安装nodejs-websocket: npm install nodejs-websocket 新建app.js文件: var ws = requ ...

  4. Cocos2d-x网络通信

    Cocos2d-x示例提供了三种内置的网咯通信类 HttpClient,WebSocket,SocketIO. 其中第一个是简单的HTTP协议的使用,提供很多Http请求方式. 剩下的Socket*是 ...

  5. Cocos2d-x 网络编程

    主要介绍内容:Http协议,Socket协议,webSocket协议, Cocos2d-x中的相关类和方法 1 Http协议 HTTP协议也叫超文本传输协议.是互联网广泛使用的通信协议,常用于B/S架 ...

  6. 漫扯:从polling到Websocket

    Http被设计成了一个单向的通信的协议,即客户端发起一个request,然后服务器回应一个response.这让服务器很为恼火:我特么才是老大,我居然不能给小弟发消息... 轮询 老大发火了,小弟们自 ...

  7. 细说WebSocket - Node篇

    在上一篇提高到了 web 通信的各种方式,包括 轮询.长连接 以及各种 HTML5 中提到的手段.本文将详细描述 WebSocket协议 在 web通讯 中的实现. 一.WebSocket 协议 1. ...

  8. java使用websocket,并且获取HttpSession,源码分析

    转载请在页首注明作者与出处 http://www.cnblogs.com/zhuxiaojie/p/6238826.html 一:本文使用范围 此文不仅仅局限于spring boot,普通的sprin ...

  9. WebSocket - ( 一.概述 )

    说到 WebSocket,不得不提 HTML5,作为近年来Web技术领域最大的改进与变化,包含CSS3.离线与存储.多媒体.连接性( Connectivity )等一系列领域,而即将介绍的 WebSo ...

随机推荐

  1. hive修改 表/分区语句

    参考 https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-AlterTable% ...

  2. mac环境brew安装freetype,imagick等yii2所需要的库

    之前整理了一下内置的php环境,各种缺库是很坑爹的,而且内置的php编译目录找了老半天没找到.所以决定使用brew去重新编译一边php brew的安装就不说了,上篇博客有说.直入主题 brew安装完p ...

  3. JVM性能调优监控工具jps、jstack、jmap、jhat、jstat、hprof使用详解

    摘要: JDK本身提供了很多方便的JVM性能调优监控工具,除了集成式的VisualVM和jConsole外,还有jps.jstack.jmap.jhat.jstat.hprof等小巧的工具,本博客希望 ...

  4. response 下载文件

    String basePath = "D://test.json"; String filename = basePath.substring(basePath.lastIndex ...

  5. CentOS忘记密码或者丢失口令解决方法

    重启系统,然后再五秒之内按下任意键. 进入下面画面后按 [ e ] 键   把光标移动到第二行(或者找到以kernel /vmlinuz开头的),再按下 [ e ] 键   在文本结尾处空一格再添加s ...

  6. 在引用KindEditor编辑器时,运行时出现以下错误:错误46 找不到类型或命名空间名称“LitJson”(是否缺少 using 指令或程序集引用?)

    将asp.net下bin文件夹下的文件LitJSON.dll拷贝到工程的bin目录下,并在工程中添加引用 在后台加入: using LitJson;

  7. 深入浅出Mybatis系列(七)---mapper映射文件配置之insert、update、delete

    上篇文章<深入浅出Mybatis系列(六)---objectFactory.plugins.mappers简介与配置>简单地给mybatis的配置画上了一个句号.那么从本篇文章开始,将会介 ...

  8. 读javascript高级程序设计17-在线检测,cookie,子cookie

    一.在线状态检测 开发离线应用时,往往在离线状态时把数据存在本地,而在联机状态时再把数据发送到服务器.html5提供了检测在线状态的方法:navigator.onLine和online/offline ...

  9. JS学习笔记--轮播图效果

    希望通过自己的学习收获哪怕收获一点点,进步一点点都是值得的,加油吧!!! 本章知识点:index this for if else 下边我分享下通过老师教的方式写的轮播图,基础知识实现: 1.css代 ...

  10. C# winform中读取HTML代码

    这次的任务是在winform建立一个表格,表格第一列需要绑定数据,表格的第一行也需要绑定数据,而其他的单元格数据则是根据对应的行数据和列数据进行提取. 询问过后,需要在后台拼接HTML代码实现这个功能 ...