python
websocket

在档次中用到socket.io抓实时推送,遂花了点时间看了socket.io实现,做个不难解析,如有错漏,欢迎指正。

安装

1 概述

socket.io是1个依照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的2个独自的商谈,它与HTTP协议的唯1涉及正是它的抓手请求能够看成1个Upgrade request行经HTTP服务器解析,且与HTTP使用同样的端口。WebSocket默许对1般性请求使用80端口,协议为ws://,对TLS加密请求使用443端口,协议为wss://

拉手是经过一个HTTP Upgrade request初步的,叁个呼吁和响应尾部示例如下(去掉了非亲非故的头顶)。WebSocket握手请求尾部与HTTP请求尾部是匹配的(见RAV4FC2616)。

## 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/一.第11中学分明的用来转移当前总是的应用层协议的头顶,表示客户端希望用现有的接连转换来新的应用层协议WebSocket协议。

  • Origin
    用于幸免跨站攻击,浏览器一般会动用那个来标识原始域,对于非浏览器的客户端应用能够遵照要求运用。

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

  • 1呼百应头中的 Sec-WebSocket-Accept 是将请求头中的 Sec-WebSocket-Key
    的值加上二个定点魔数258EAFA5-E914-47DA-95CA-C5AB0DC85B11经SHA壹+base6四编码后获取。计算进程的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的值不得法或许状态码不是拾一,则不会确立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为一,分片帧的率先个分片的FIN为0,最后叁个分片FIN为1。
  • opcode: 帧类型编号,在那之中央控制制帧:0x8 (Close), 0x九 (Ping), and 0xA
    (Pong),数据帧首要有:0x一 (Text), 0x2 (Binary)。
  • MASK:客户端发给服务端的帧MASK为一,Masking-key为加密掩码。服务端发往客户端的MASK为0,Masking-key为空。
  • Payload len和Payload Data分别是帧的数据长度和多少内容。

 

3 engine.io和socket.io

眼下提到socket.io是基于engine.io的包装,engine.io(协议版本叁)有1套自身的情商,任何engine.io服务器都必须帮忙polling(包罗jsonp和xhr)和websocket三种传输形式。engine.io使用websocket时有壹套本身的ping/pong机制,使用的是opcode为0x一(Text)类型的数据帧,不是websocket协商规定的ping/pong类型的帧,标准的
ping/pong 帧被uwsgi使用

engine.io的数据编码分为Packet和Payload,当中 Packet是数据包,有四种档次:

  • 0 open:从服务端发出,标识三个新的传输方式已经开辟。
  • 1 close:请求关闭那条传输连接,可是它自己并不关门那一个接二连三。
  • 贰ping:客户端周期性发送ping,服务端响应pong。注意那几个与uwsgi自带的ping/pong不壹样,uwsgi里面发送ping,而浏览器再次回到pong。
  • 三 pong:服务端发送。
  • 四 message:实际发送的音信。
  • 5upgrade:在转移transport前,engine.io会发送探测包测试新的transport(如websocket)是不是可用,要是OK,则客户端会发送三个upgrade新闻给服务端,服务端关闭老的transport然后切换到新的transport。
  • 6noop:空操作数据包,客户端收到noop音信会将事先等待暂停的轮询暂停,用于在吸收接纳到四个新的websocket强制二个新的轮询周期。

而Payload是指壹多元绑定到壹块儿的编码后的Packet,它只用在poll中,websocket里面使用websocket帧里面包车型客车Payload字段来传输数据。倘若客户端不扶助XH锐界二,则payload格式如下,在那之中length是多少包Packet的尺寸,而packet则是编码后的多寡包内容。

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

若辅助XHEvoque二,则payload中内容总体以2进制编码,其中第4位0表示字符串,一意味着二进制数据,而前面跟着的数字则是表示packet长度,然后以\xff结尾。要是一个长度为拾玖的字符类型的数据包,则前边长度编码是
\x00\x01\x00\x09\xff,然后后边接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唯1即可。socket.io基于engine.io,帮忙websocket和long
polling。尽管是long polling,会定时发送GET,
POST请求,当未有数量时,GET请求在拉取队列音信时会hang住(超时时间为ping提姆eout),固然hang住中间服务器一直未有数据产生,则需求等到客户端发送下3个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版本为一.玖.0,engine.io版本为二.0.四。

先来看一下,长连接调用方式:

连接建立

率先,客户端会发送一个polling请求来建立连接。此时的央浼参数未有sid,表示要树立连接。
engine.io服务器通过handle_get_request()handle_post_request()办法来分别处理开首化连接以及长轮询中的
GET 和 POST 请求。

socket.io在开始化时便登记了一个事件到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事件。

客户端第3回一而再的时候,socket.io也要做1些开始化的劳作,那是在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等安顿和参数;另2个是socket.io的connect数据包,内容为40。在那之中四代表的是engine.io的message音信,0则代表socket.io的connect音讯,以字节流回到。那里的pingTimeout客户端和服务端共享这几个布局,用于检查测试对端是或不是过期。

继而会发送三个轮询请求和websocket握手请求,假如websocket握手成功后客户端会发送2 probe探测帧,服务端回应3 probe,然后客户端会发送内容为5的Upgrade帧,服务端回应内容为6的noop帧。探测帧检查通过后,客户端停止轮询请求,将传输通道转到websocket连接,转到websocket后,接下去就从头为期(暗中认可是二伍秒)的
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()函数处理:

  • 对于轮询,1旦接受了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跟上2个ping之间超过了pingTimeout;用的uwsgi的话,uwsgi发送ping,固然在websockets-pong-tolerance(默许3秒)内收取不到pong回应,也会关闭连接;还有假使nginx的proxy_read_timeout配置的比pingInterval小等。

假设不是客户端主动关闭连接,socket.io就会在连年出错后不断重试以创立连接。重试间隔和重试次数由reconnectionDelayMax(默认5秒)reconnectionAttempts(暗中同意平昔重连)设定。上面研商客户端通常关闭的情况,种种十分关闭状态请具体意况具体分析。

客户端主动关闭

若果客户端调用socket.close()当仁不让关闭websocket连接,则会头阵送1个音讯41(四:engine.io的message,一: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方法1致会触发socket.io从前注册的disconnect事件处理函数,由于前边已经调用_handle_disconnect()拍卖了关闭连接事件,所以那边_handle_eio_disconnect()不要求再做其它操作(那几个操作不是剩下的,其效用见后一节)。

浏览器关闭

直接关门浏览器发送的是websocket的标准CLOSE音讯,opcode为八。socket.io服务端处理格局基本1致,由于那种景观下并从未发送socket.io的倒闭音信41,socket.io的关门操作必要等到engine.io触发的_handle_eio_disconnect()中拍卖,那就是前壹节中为啥engine.io服务器前边还要多调用2次
_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情势基本1致。实例只针对使用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标识回显回来。

(二)header:
客户发送websocket握手请求的央求头,{‘head1:value一’,’head2:value二’}。

建立连接

在chrome中打开页面能够见到发了1个请求,分别是:

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是八个随意字符串,第二个请求时还还未有生成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类型是四(message),而它的数额内容是0,表示socket.io的CONNECT。而其间的看起来乱码的1些其实是前面提到的payload编码中的长度的编码\x00\x01\x00\x09\xff\x00\x02\xff

  • 第三个请求是轮询请求,假若websocket建立并测试成功(使用内容为probe的ping/pong帧)后,会暂停轮询请求。能够见见轮询请求一贯hang住到websocket建立并测试成功后才重回,响应结果是�ÿ6,前边乱码部分是payload长度编码\x00\x01\xff,后边的数字6是engine.io的noop音信。

  • 第一个请求是websocket握手请求,握手成功后,能够在chrome的Frames里面看到websocket的多寡帧交互流程,能够看看如前方分析,确实是首发的探测帧,然后是Upgrade帧,接着正是定期的ping/pong帧了。

    2probe
    3probe
    5
    2
    3
    ...
    

(3)on_open:在成立Websocket握手时调用的可调用对象,这么些法子唯有3个参数,便是此类本人。

客户端发送音信给服务端

如果要发送音讯给服务器,在浏览器输入框输入test,点击echo按钮,可以见见websocket发送的帧的内容如下,个中四是engine.io的message类型标识,贰是socket.io的EVENT类型标识,而背后则是事件名称和数量,数据能够是字符串,字典,列表等品种。

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

(4)on_message:那几个目的在收受到服务器重回的消息时调用。有四个参数,3个是此类自身,2个是大家从服务器获取的字符串(utf-八格式)。

服务端接收音讯流程

而服务端接收音讯并回到七个新的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:在遇见一而再关闭的情景时调用,参数唯有2个,正是此类本人。

闭馆连接

客户端要勇往直前关闭连接,在JS中调用 socket.close()
即可,此时出殡和埋葬的数目包为
41,当中4意味着的是engine.io的新闻类型message,而数据一则是指的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-八),数据类型,一连标志。

参考资料

  • 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:贰个2进制的标志位,假设为True,那几个app的主循环将不止运转,私下认可值为True。

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

(1一)subprotocols:1组可用的子协议,默许为空。

 

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

 假若持续开关闭websocket连接,会间接不通下去。其它这么些函数带多少个参数,若是传的话,运营心跳包发送。

 

永利皇宫 ,ping_interval:自动发送“ping”命令,种种钦赐的时间(秒),倘使设置为0,则不会活动发送。

网站地图xml地图