澳门至尊网站-首页

您的位置:澳门至尊网站 > 搜索引擎 > 原理研讨,WebSocket长连接心跳与短连接

原理研讨,WebSocket长连接心跳与短连接

2019-10-16 15:24

python websocket

在品种中用到socket.io抓牢时推送,遂花了点时间看了socket.io达成,做个简易解析,如有错漏,款待指正。

安装

1 概述

socket.io是三个依照WebSocket的CS的实时通讯库,它底层基于engine.io。engine.io使用WebSocket和xhr-polling(或jsonp)封装了一套自身的合计,在不援助WebSocket的低版本浏览器中(扶植websocket的浏览器版本见这里)使用了长轮询(long polling)来代表。socket.io在engine.io的底子上扩张了namespace,room,自动重连等特色。

正文接下去会先简介websocket协议,然后在这里基础上上课下engine.io和socket.io契约以至源码解析,后续再通过例子表明socket.io的行事流程。

pip install websocket-client

2 WebSocket协议

我们知晓,在HTTP 合同开采的时候,并不是为了双向通讯程序希图的,初步的 web 应用程序只供给 “央浼-响应” 就够了。由于历史原因,在创立具有双向通讯机制的 web 应用程序时,就只可以利用 HTTP 轮询的章程,因而发出了 “短轮询” 和 “长轮询”(注意区分短连接和长连接)。

短轮询通过客户端定时轮询来打探服务端是或不是有新的消息发生,短处也是无人不晓,轮询间距大了则消息相当不足实时,轮询间隔过小又会消耗过多的流量,扩展服务器的负担。长轮询是对短轮询的优化,要求服务端做相应的修改来帮忙。客商端向服务端发送央求时,如若此刻服务端未有新的音讯产生,并不立时回去,而是Hang住一段时间等有新的音信依旧逾期再回去,客商端收到服务器的对答后持续轮询。能够看见长轮询比短轮询能够减小大气无效的伸手,并且客户端接抽出新信息也会实时不菲。

虽说长轮询比短轮询优化了比很多,然而每一回伏乞还是都要带上HTTP央求底部,何况在长轮询的一连达成现在,服务器端积存的新音讯要等到后一次客户端连接时技艺传递。越来越好的方法是只用一个TCP连接来兑现顾客端和服务端的双向通讯,WebSocket磋商就是为此而生。WebSocket是根据TCP的一个单身的磋商,它与HTTP左券的当世无双涉及就是它的抓手伏乞可以当作叁个Upgrade request经由HTTP服务器深入分析,且与HTTP使用同一的端口。WebSocket暗中同意对平时恳求使用80端口,公约为ws://,对TLS加密乞求使用443端口,左券为wss://

握手是通过一个HTTP Upgrade request千帆竞发的,多少个伸手和响应尾部示比如下(去掉了非亲非故的底部)。WebSocket握手央浼尾部与HTTP央浼底部是极度的(见LX570FC2616)。

## Request Headers ##
Connection: Upgrade
Host: socket.io.demo.com
Origin: http://socket.io.demo.com
Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits
Sec-WebSocket-Key: mupA9l2rXciZKoMNQ9LphA==
Sec-WebSocket-Version: 13
Upgrade: websocket

## Response Headers ##
101 Web Socket Protocol Handshake
Connection: upgrade
Sec-WebSocket-Accept: s4VAqh7eedG0a11ziQlwTzJUY3s=
Sec-WebSocket-Origin: http://socket.io.demo.com
Server: nginx/1.6.2
Upgrade: WebSocket
  • Upgrade 是HTTP/1.第11中学规定的用于转移当前线总指挥部是的应用层合同的头部,表示顾客端希望用现存的总是转变来新的应用层公约WebSocket公约。

  • Origin 用于防止跨站攻击,浏览器日常会动用那些来标记原始域,对于非浏览器的客商端应用能够依据供给运用。

  • 需要头中的 Sec-WebSocket-Version 是WebSocket版本号,Sec-WebSocket-Key 是用来握手的密钥。Sec-WebSocket-Extensions 和 Sec-WebSocket-Protocol 是可挑选,暂不研商。

  • 一呼百应头中的 Sec-WebSocket-Accept 是将乞求头中的 Sec-WebSocket-Key 的值加上叁个定位魔数258EAFA5-E914-47DA-95CA-C5AB0DC85B11经SHA1+base64编码后收获。总结进程的python代码示例(uwsgi中的完结见 core/websockets.c的 uwsgi_websocket_handshake函数):

    magic_number = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
    key = 'mupA9l2rXciZKoMNQ9LphA=='
    accept = base64.b64encode(hashlib.sha1(key + magic_number).digest())
    assert(accept == 's4VAqh7eedG0a11ziQlwTzJUY3s=')
    
  • 客商端会检查响应头中的status code 和 Sec-WebSocket-Accept 值是不是是期望的值,即便开掘Accept的值不科学也许状态码不是101,则不会创立WebSocket连接,也不会发送WebSocket数据帧。

WebSocket协商使用帧(Frame)收发数据,帧格式如下。基于安全考量,客户端发送给服务端的帧必得经过4字节的掩码(Masking-key)加密,服务端收到消息后,用掩码对数据帧的Payload Data举行异或运算解码得到数码(详见uwsgi的 core/websockets.c 中的uwsgi_websockets_parse函数),假如服务端收到未经掩码加密的数据帧,则应当及时关闭该WebSocket。而服务端发给顾客端的数额则无需掩码加密,顾客端借使接到了服务端的掩码加密的数目,则也必需关闭它。

 0                   1                   2                   3
      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
     +-+-+-+-+-------+-+-------------+-------------------------------+
     |F|R|R|R| opcode|M| Payload len |    Extended payload length    |
     |I|S|S|S|  (4)  |A|     (7)     |             (16/64)           |
     |N|V|V|V|       |S|             |   (if payload len==126/127)   |
     | |1|2|3|       |K|             |                               |
     +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
     |     Extended payload length continued, if payload len == 127  |
     + - - - - - - - - - - - - - - - +-------------------------------+
     |                               |Masking-key, if MASK set to 1  |
     +-------------------------------+-------------------------------+
     | Masking-key (continued)       |          Payload Data         |
     +-------------------------------- - - - - - - - - - - - - - - - +
     :                     Payload Data continued ...                :
     +---------------------------------------------------------------+

帧分为调整帧和数据帧,调节帧不可能分片,数据帧能够分片。主要字段表达如下:

  • FIN: 未有分片的帧的FIN为1,分片帧的第二个分片的FIN为0,最终叁个分片FIN为1。
  • opcode: 帧类型编号,此中调整帧:0x8 (Close), 0x9 (Ping), and 0xA (Pong),数据帧首要有:0x1 (Text), 0x2 (Binary)。
  • MASK:客商端发给服务端的帧MASK为1,Masking-key为加密掩码。服务端发往客商端的MASK为0,Masking-key为空。
  • Payload len和Payload Data分别是帧的多长和多少内容。

 

3 engine.io和socket.io

日前提到socket.io是基于engine.io的包裹,engine.io(合同版本3)有一套本身的商业事务,任何engine.io服务器都无法不协理polling(包罗jsonp和xhr)和websocket二种传输格局。engine.io使用websocket时有一套自个儿的ping/pong机制,使用的是opcode为0x1(Text)类型的数据帧,不是websocket合计规定的ping/pong类型的帧,标准的 ping/pong 帧被uwsgi使用

engine.io的数据编码分为Packet和Payload,在这之中 Packet是数据包,有6种档期的顺序:

  • 0 open:从服务端发出,标记二个新的传输格局已经开采。
  • 1 close:诉求关闭那条传输连接,不过它本身并不停业这些一而再。
  • 2 ping:客商端周期性发送ping,服务端响应pong。注意这些与uwsgi自带的ping/pong不雷同,uwsgi里面发送ping,而浏览器重返pong。
  • 3 pong:服务端发送。
  • 4 message:实际发送的消息。
  • 5 upgrade:在转移transport前,engine.io会发送探测包测量试验新的transport(如websocket)是不是可用,借使OK,则客商端会发送八个upgrade新闻给服务端,服务端关闭老的transport然后切换来新的transport。
  • 6 noop:空操作数据包,客户端收到noop新闻会将以前等待暂停的轮询暂停,用于在接受到二个新的websocket强制一个新的轮询周期。

而Payload是指一层层绑定到一道的编码后的Packet,它只用在poll中,websocket里面使用websocket帧里面包车型地铁Payload字段来传输数据。借使客商端不支持XHRAV42,则payload格式如下,个中length是数量包Packet的长度,而packet则是编码后的数据包内容。

<length1>:<packet1>[<length2>:<packet2>[...]]

若援助XHCRUISER2,则payload中剧情全方位以二进制编码,当中第四位0表示字符串,1代表二进制数据,而背后随着的数字则是意味着packet长度,然后以xff结尾。假使四个长度为109的字符类型的数据包,则前面长度编码是 x00x01x00x09xff,然后后边接packet内容。

<0 for string data, 1 for binary data><Any number of numbers between 0 and 9><The number 255><packet1 (first type,
then data)>[...]

engine.io服务器维护了三个socket的字典结构用于管理总是到该机的客商端,而顾客端的标志正是sid。假使有多个worker,则供给确定保证同三个顾客端的延续落在平等台worker上(能够配备nginx依据sid分发)。因为种种worker只保证了一局地顾客端连接,若是要补助广播,room等风味,则后端须要利用 redis 可能 RabbitMQ 音信队列,使用redis的话则是由此redis的订阅发表机制落到实处多机多worker之间的新闻推送。

socket.io是engine.io的包裹,在其基础上扩大了机动重连,多路复用,namespace,room等特色。socket.io本人也会有一套合同,它Packet类型分为(CONNECT 0, DISCONNECT 1, EVENT 2, ACK 3, ERROR 4, BINARY_EVENT 5, BINARY_ACK 6)。注意与engine.io的Packet类型有所不一样,不过socket.io的packet实际是依赖的engine.io的Message类型发送的,在后头实例中能够看来Packet的编码情势。当连接出错的时候,socket.io会通过机关重连机制再度连接。

 

4 源码深入分析

在创设连接后,每一种socket会被自动踏入到贰个暗中同意的命名空间/。在每一种命名空间中,socket会被暗许加入三个名称叫Nonesid的房屋。None的房屋用于广播,而sid是时下客商端的session id,用于单播。除暗中认可的屋企外,大家得以依据要求将对应socket参与自定义房间,roomid独一就可以。socket.io基于engine.io,支持websocket和long polling。如若是long polling,会按时发送GET, POST央浼,当不多时,GET央求在拉取队列新闻时会hang住(超时时间为pingTimeout),假若hang住中间服务器平素未曾多少发生,则须要等到客商端发送下一个POST央浼时,此时服务器会往队列中蕴藏POST央浼中的消息,那样上三个GET央浼才会再次回到。若是upgrade到了websocket连接,则会定时ping/pong来保活连接。

为实惠描述,上面提到的engine.io服务器对应源文件是engineio/server.py,engine.io套接字对应源文件engineio/socket.py,而socket.io服务器则对应socketio/server.py。上面深入分析下socket.io连接创建、音信接收和发送、连接关闭进度。socket.io版本为1.9.0,engine.io版本为2.0.4。

先来看一下,长连接调用格局:

接连创设

先是,客商端会发送二个polling伏乞来树立连接。此时的哀告参数未有sid,表示要创立连接。 engine.io服务器通过handle_get_request()handle_post_request()主意来分别管理起首化连接以致长轮询中的 GET 和 POST 央浼。

socket.io在开端化时便登记了3个事件到engine.io的handlers中,分别是connect(处理函数_handle_eio_connect),message(_handle_eio_message),disconnect(_handle_eio_disconnect),在engine.io套接字接收到了上述多个类其他音信后,在本人做了对应管理后都会触发socket.io中的对应的管理函数做更加的管理。

当接到到GET诉求且未有sid参数时,则engine.io服务器会调用 _handle_connect()措施来建设构造连接。这么些主意首要工作是为日前顾客端生成sid,成立Socket对象并保留到engine.io服务器的sockets会集中。做了这几个开头化工作后,engine.io服务器会发送叁个OPEN类型的数额包给客商端,接着会触发socket.io服务器的connect事件。

客商端第贰遍再三再四的时候,socket.io也要做一些开端化的做事,那是在socket.io服务器的_handle_eio_connect()拍卖的。这里做的政工根本有几点:

  • 开端化manager,比方用的是redis做后端队列的话,则须要开头化redis_manager,富含安装redis连接配置,订阅频道,私下认可频道是"socket.io",倘若应用flask_socketio则频道是"flask_socketio",如果用到gevent,则还要对redis模块的socket库打monkey-patch等。

  • 将该客商端加入到暗中同意房间None,sid中。

  • 调用代码中对connect事件注册的函数。如上边那个,注意下,socket.io中也是有个用于事件管理的handlers,它保存的是在后端代码中对socket.io事件注册的函数(开采者定义的),而engine.io的handlers中保存的函数是socket.io注册的那八个针对connect,message和disconnect事件的定位的管理函数。

    socketio.on("connect")
    def test_connect():
        print "client connected"
    
  • 发送二个sockeio的connect数据包给客商端。

末尾在响应中engine.io会为顾客端设置贰个名称为io值为sid的cookie,响应内容payload包涵八个数据包,贰个是engine.io的OPEN数据包,内容为sid,pingTimeout等布置和参数;另八个是socket.io的connect数据包,内容为40。此中4表示的是engine.io的message新闻,0则象征socket.io的connect音讯,以字节流回到。这里的pingTimeout客户端和服务端分享那个布局,用于检查测量试验对端是或不是过期。

继而会发送叁个轮询央求和websocket握手央求,如果websocket握手成功后客商端会发送2 probe探测帧,服务端回应3 probe,然后客商端会发送内容为5的Upgrade帧,服务端回应内容为6的noop帧。探测帧检查通过后,客商端甘休轮询央求,将传输通道转到websocket连接,转到websocket后,接下去就开端定期(暗许是25秒)的 ping/pong(那是socket.io自定义的ping/pong,除外,uwsgi也会定时(暗中同意30秒)对客商端ping,客商端回应pong,那么些在chrome的Frames里面是看不到的,必要依据wireshark大概用别的浏览器插件来观看)。

    ws = websocket.WebSocketApp("ws://echo.websocket.org/",
                              on_message = on_message,
                              on_error = on_error,
                              on_close = on_close)
    ws.on_open = on_open
    ws.run_forever()

服务端音信接收流程

对接受音信的则统一通过engine.io套接字的receive()函数管理:

  • 对此轮询,一旦接受了polling的POST伏乞,则会调用receive往该socket的音讯队列之中发送新闻,进而释放在此以前hang住的GET诉求。
  • 对于websocket:
    • 收纳了ping,则会及时响应一个pong。
    • 吸收接纳到了upgrade音讯,则即时发送三个noop音讯。
    • 收下到了message,则调用socket.io注册到engine.io的_handle_eio_message措施来处理socket.io自身定义的种种信息。

 

服务端音信发送流程

而服务端要给顾客端发送音信,则供给通过socket.io服务器的emit方法,注意emit方法是对准room来发送音讯的,若是是context-aware的,则emit默许是对namespace为/且room名称叫sid的房间发送,假设是context-free的,则暗中同意是广播即对持有连接的客商端发送音信(当然在context-free的场景下边,你也足以钦点room来只给钦定room推送音信)。

socket.io要达成多进程乃至广播,房间等效果,势绝对要连接一个redis之类的音讯队列,进而socket.io的emit会调用对应队列管理器pubsub_manager的emit方法,举例用redis做音讯队列则最后调用 redis_manager中的_publish() 方法通过redis的订阅发布功效将新闻推送到flask_socketio频道。另一方面,全数的socket在一而再时都订阅了 flask_socketio频道,並且都有八个体协会程(或线程)在监听频道中是不是有新闻,一旦有音信,就能够调用pubsub_manager._handle_emit()办法对本机对应的socket发送对应的音讯,最后是透过socket.io服务器的_emit_internal()方法实现对本机中room为sid的具备socket发送音信的,即使room为None,则就是广播,即对持有连接到本机的有着客商端推送音讯。

socket.io服务器发送音讯要基于engine.io音讯包装,所以总结到底照旧调用的engine.io套接字中的send()艺术。engine.io为每一种客商端都会维护三个新闻队列,发送数据都以先存到行列之中待拉取,websocket除了探测帧之外的另外数据帧也都是通过该音讯队列发送。

 长连接,参数介绍:

关门连接(只解析websocket)

websocket恐怕那一个关闭的图景多多。比方顾客端发了ping后伺机pong超时关闭,服务端接收到ping跟上二个ping之间超过了pingTimeout;用的uwsgi的话,uwsgi发送ping,若是在websockets-pong-tolerance(私下认可3秒)内接收不到pong回应,也会停业连接;还应该有如果nginx的proxy_read_timeout配置的比pingInterval小等。

若是否客商端主动关闭连接,socket.io就能够在一而再出错后不断重试以树立连接。重试间距和重试次数由reconnectionDelayMax(默认5秒)reconnectionAttempts(默许一向重连)设定。上面研究客商端寻常关闭的境况,各样非常关闭状态请具体情形具体剖判。

客商端主动关闭

假若顾客端调用socket.close()积极关闭websocket连接,则会首发送二个新闻41(4:engine.io的message,1:socket.io的disconnect)再关闭连接。如前方提到,engine.io套接字接收到音讯后会交给socket.io服务器注册的 _handle_eio_message()管理。最后是调用的socket.io的_handle_disconnect(),该函数职业包蕴调用socketio.on("disconnect")注册的函数,将该顾客端从参与的屋家中移除,清理情形变量等。

uwsgi而接受到客商端关闭websocket连接音信后会关闭服务端到顾客端的连日。engine.io服务器的websocket数据接收例程ws.wait()因为延续关闭报IOError,触发服务端循环收发数据经过甘休,并从掩护的sockets集结中移除那一个闭馆的sid。然后调用engine.io套接字的close(wait=True, abort=True)主意,由于是客商端主动关闭,这里就不会再给客商端发送贰个CLOSE音讯。而 engine.io服务器的close方法一致会触发socket.io此前注册的disconnect事件管理函数,由于前面已经调用_handle_disconnect()拍卖了停业连接事件,所以这边_handle_eio_disconnect()无需再做别的操作(这几个操作不是多余的,其遵循见后一节)。

浏览器关闭

直接关闭浏览器发送的是websocket的规范CLOSE新闻,opcode为8。socket.io服务端管理格局基本一致,由于这种情景下并从未发送socket.io的停业音信41,socket.io的闭馆操作供给等到engine.io触发的_handle_eio_disconnect()中拍卖,那正是前一节中为何engine.io服务器前边还要多调用一遍 _handle_eio_disconnect()的原由所在。

(1)url: websocket的地址。

5 实例

共谋表明轻易令人有个别头晕,websocket,engine.io,socket.io,各自公约是什么样行事的,看看实例或者会比较清晰,为了方便测量检验,作者写了个Dockerfile,安装了docker的童鞋能够拉替代码施行 bin/start.sh 就可以运转具备完全的 nginx+uwsgi+gevent+flask_socketio测量试验情况的容器最早测量检验,浏览器展开http://127.0.0.1就可以测量试验。async_mode用的是gevent_uwsgi,完整代码见 这里。

对于不帮忙websocket的低版本浏览器,socket.io会退化为长轮询的秘技,通过按时的出殡GET, POST央浼来拉取数据。异常少时,会将呼吁数据的GET须求hang住,直到服务端有数据暴发恐怕顾客端的POST诉求将GET需要释放,释放之后会随着再一次发送一个GET央浼,除却,合同解析和管理流程与websocket格局基本一致。实例只针对利用websocket的打开解析

为了侦察socket.io顾客端的调用流程,可以设置localStorage.debug = '*';,测验的前段代码片段如下(完整代码见酒店):

 <script type="text/javascript" charset="utf-8">
    var socket = io.connect('/', {
        "reconnectionDelayMax": 10000,
        "reconnectionAttempts": 10
    });
    socket.on('connect', function() {
        $('#log').append('<br>' + $('<div/>').text('connected').html());
    })

    $(document).ready(function() {

        socket.on('server_response', function(msg) {
            $('#log').append('<br>' + $('<div/>').text('Received from server: ' + ': ' + msg.data).html());
        });

        $('form#emit').submit(function(event) {
            socket.emit('client_event', {data: $('#emit_data').val()});
            return false;
        });
    });

 </script>

测量试验代码比较轻巧,引进socket.io的js库文件,然后在接二连三成功后在页面突显“connected”,在输入框输入文字,能够通过三番五次发送至服务器,然后服务器将浏览器发送的字符串加上server标志回显回来。

(2)header: 顾客发送websocket握手供给的伏乞头,{'head1:value1','head2:value2'}。

创设连接

在chrome中开采页面可以见到发了3个必要,分别是:

1 http://127.0.0.1/socket.io/?EIO=3&transport=polling&t=MAkXxBR
2 http://127.0.0.1/socket.io/? EIO=3&transport=polling&t=MAkXxEz&sid=9c54f9c1759c4dbab8f3ce20c1fe43a4
3 ws://127.0.0.1/socket.io/?EIO=3&transport=websocket&sid=9c54f9c1759c4dbab8f3ce20c1fe43a4

呼吁暗中同意路线是/socket.io,注意命名空间并不会在路径中,而是在参数中传送。第一个须求是polling,EIO是engine.io公约的版本号,t是三个Infiniti制字符串,第一个恳求时还还未曾生成sid。服务端接收到新闻后会调用engine.io/server.py_handle_connect()建设构造连接。

归来的结果是

## Response Headers: Content-Type: application/octet-stream ##
�ÿ0{"pingInterval":25000,"pingTimeout":60000,"upgrades":["websocket"],"sid":"9c54f9c1759c4dbab8f3ce20c1fe43a4"}�ÿ40

能够观望,这里重临的是字节流的payload,content-type为"application/octet-stream"。那些payload其实满含五个packet,第一个packet是engine.io的OPEN新闻,类型为0,它的原委为pingInterval,pingTimeout,sid等;第三个packet类型是4(message),而它的多寡内容是0,表示socket.io的CONNECT。而里边的看起来乱码的有个别其实是前面提到的payload编码中的长度的编码x00x01x00x09xffx00x02xff

  • 第4个央浼是轮询央求,假诺websocket创设并测量试验成功(使用内容为probe的ping/pong帧)后,会中断轮询乞请。能够见到轮询央求一向hang住到websocket创建并测量检验成功后才回到,响应结果是�ÿ6,后边乱码部分是payload长度编码x00x01xff,前面包车型地铁数字6是engine.io的noop音信。

  • 首个乞求是websocket握手央求,握手成功后,能够在chrome的Frames中间来看websocket的数目帧交互流程,能够看出如前方深入分析,确实是头阵的探测帧,然后是Upgrade帧,接着正是定期的ping/pong帧了。

    2probe
    3probe
    5
    2
    3
    ...
    

(3)on_open:在创立Websocket握手时调用的可调用对象,那么些艺术独有贰个参数,正是此类自己。

客户端发送音讯给服务端

假定要发送音讯给服务器,在浏览器输入框输入test,点击echo开关,能够看见websocket发送的帧的内容如下,在那之中4是engine.io的message类型标记,2是socket.io的EVENT类型标记,而前面则是事件名称和数据,数据能够是字符串,字典,列表等门类。

42["client_event",{"data":"test"}]

(4)on_message:这几个指标在接收到服务器重回的音信时调用。有多个参数,五个是此类自己,二个是大家从服务器获取的字符串(utf-8格式)。

服务端接收信息流程

而服务端接收消息并再次回到三个新的event为"server_response",数据为"TEST",代码如下,此中socketio是flask_socketio模块的SocketIO对象,它提供了装饰器方法 on将自定义的client_event和管理函数test_client_event注册到sockerio服务器的handlers中。

当收到到 client_event 消息时,会通过sockerio/server.py中的 _handle_eio_message()艺术管理新闻,对于socket.io的EVENT类型的音信最后会经过_trigger_event()办法管理,该方式也等于从handlers中获得client_event对应的管理函数并调用之。

from flask_socketio import SocketIO, emit
socketio = SocketIO(...)

@socketio.on("client_event")
def test_client_event(msg):
    emit("server_response", {"data": msg["data"].upper()})

(5)on_error:这几个指标在碰着错误时调用,有四个参数,第三个是此类本人,第叁个是可怜对象。

服务端发送新闻到客商端

服务端发送消息通过 flask_socketio提供的emit方法实现,如前一节分析的,最终依旧通过的engine.io包装成engine.io的音讯格式后发生。

42["server_response",{"data":"TEST"}]

(6)on_close:在碰到接二连三关闭的动静时调用,参数唯有贰个,正是此类自身。

关门连接

客商端要前赴后继关闭连接,在JS中调用 socket.close() 就能够,此时出殡的多少包为 41,当中4意味着的是engine.io的信息类型message,而数据1则是指的socket.io的新闻类型disconnect,关闭流程见上一章的求证。

(7)on_cont_message:这一个指标在收受到一而再帧数据时被调用,有四个参数,分别是:类自个儿,从服务器接受的字符串(utf-8),接二连三标记。

6 总结

正文示例中,为了方便深入分析,只用了暗许的namespace和room,而在其实项目中得以依赖作业必要利用namespace,room等高等性情。

nginx+uwsgi采用socket.io时,当用到websocket时,注意nginx的过期配置proxy_read_timeout和uwsgi的websocket超时配置websocket-ping-freq和websockets-pong-tolerance,配置不当会导致socke.io因为websocket的ping/pong超时而不息重连。

(8)on_data:当从服务器收到到新闻时被调用,有八个参数,分别是:该类本身,接收到的字符串(utf-8),数据类型,延续标记。

参照他事他说加以考察资料

  • https://tools.ietf.org/html/rfc6455
  • https://www.nginx.com/blog/websocket-nginx/
  • https://security.stackexchange.com/questions/36930/how-does-websocket-frame-masking-protect-against-cache-poisoning
  • https://github.com/suexcxine/blog/blob/master/source/_posts/websocket.md
  • https://github.com/abbshr/abbshr.github.io/issues/47
  • https://socket.io/docs/logging-and-debugging/
  • http://uwsgi-docs.readthedocs.io/en/latest/WebSockets.html
  • https://flask-socketio.readthedocs.io/en/latest/

(9)keep_running:三个二进制的标识位,假若为True,那个app的主循环将不断运维,私下认可值为True。

(10)get_mask_key:用于发生三个掩码。

(11)subprotocols:一组可用的子公约,默以为空。

 

长连接重要措施:ws.run_forever(ping_interval=60,ping_timeout=5)

 假如持续开关闭websocket连接,会直接不通下去。其余那么些函数带七个参数,要是传的话,运行心跳包发送。

 

ping_interval:自动发送“ping”命令,每一个钦点的小运(秒),借使设置为0,则不会自动发送。

ping_timeout:若无接过pong音讯,则为超时(秒)。

ws.run_forever(ping_interval=60,ping_timeout=5)

#ping_interval心跳发送间隔时间

#ping_timeout 设置,发送ping到收到pong的超时时间

 

小编们看源代码,会发觉这么一断代码:

ping的逾期时间,要高于ping间距时间

 

        if not ping_timeout or ping_timeout <= 0:
            ping_timeout = None
        if ping_timeout and ping_interval and ping_interval <= ping_timeout:
            raise WebSocketException("Ensure ping_interval > ping_timeout")

 

 

 

 

长连接:

示例1:

 

import websocket
try:
    import thread
except ImportError:
    import _thread as thread
import time

def on_message(ws, message):
    print(message)

def on_error(ws, error):
    print(error)

def on_close(ws):
    print("### closed ###")


def on_open(ws):
    def run(*args):
        ws.send("hello1")
        time.sleep(1)
        ws.close()
    thread.start_new_thread(run,())

if __name__ == "__main__":
    websocket.enableTrace(True)
    ws = websocket.WebSocketApp("ws://echo.websocket.org/",
                              on_message = on_message,
                              on_error = on_error,
                              on_close = on_close)
    ws.on_open = on_open
    ws.run_forever(ping_interval=60,ping_timeout=5)

 

示例2:

import websocket
from threading import Thread
import time
import sys


class MyApp(websocket.WebSocketApp):
    def on_message(self, message):
        print(message)

    def on_error(self, error):
        print(error)

    def on_close(self):
        print("### closed ###")

    def on_open(self):
        def run(*args):
            for i in range(3):
                # send the message, then wait
                # so thread doesn't exit and socket
                # isn't closed
                self.send("Hello %d" % i)
                time.sleep(1)

            time.sleep(1)
            self.close()
            print("Thread terminating...")

        Thread(target=run).start()


if __name__ == "__main__":
    websocket.enableTrace(True)
    if len(sys.argv) < 2:
        host = "ws://echo.websocket.org/"
    else:
        host = sys.argv[1]
    ws = MyApp(host)
    ws.run_forever()

 

 

短连接:

from websocket import create_connection
ws = create_connection("ws://echo.websocket.org/")
print("Sending 'Hello, World'...")
ws.send("Hello, World")
print("Sent")
print("Receiving...")
result =  ws.recv()
print("Received '%s'" % result)
ws.close()

 

——

本文由澳门至尊网站发布于搜索引擎,转载请注明出处:原理研讨,WebSocket长连接心跳与短连接

关键词: