当前位置:9992019银河国际 > www.9992019.com > 长连接调用方式,它底层基于engine.io

长连接调用方式,它底层基于engine.io

文章作者:www.9992019.com 上传时间:2019-10-22

 假若持续开关闭websocket连接,会平昔不通下去。此外那些函数带八个参数,假使传的话,运行心跳包发送。

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字段来传输数据。如若顾客端不扶助XHTiggo2,则payload格式如下,此中length是多少包Packet的长短,而packet则是编码后的数目包内容。

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

若支持XH大切诺基2,则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会通过机关心注重连机制再度连接。

(11)subprotocols:如日中天组可用的子合同,默感觉空。

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

  • 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/
        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")

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央求底部是万分的(见EscortFC2616)。

## 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分别是帧的多寡长度和数据内容。

 

在项目中用到socket.io加强时推送,遂花了点时间看了socket.io实现,做个简易剖判,如有错漏,招待指正。

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

连天创建

第黄金时代,客户端会发送八个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只怕用任何浏览器插件来察看)。

 

服务端音讯选拔流程

对吸收接纳音信的则统一通过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除了探测帧之外的其他数据帧也都以通过该新闻队列发送。

ping_interval:自动发送“ping”命令,各种钦定的时日(秒),如若设置为0,则不会自行发送。

服务端选择音信流程

而服务端采撤废息并赶回多少个新的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()})

示例2:

服务端发送音信到顾客端

服务端发送消息通过 flask_socketio提供的emit方法达成,如前活龙活现节深入分析的,最后照旧通过的engine.io包装成engine.io的消息格式后发生。

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

(3)on_open:在建构Websocket握手时调用的可调用对象,这一个方式独有四个参数,便是此类本身。

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。

 

闭馆连接(只分析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()的由来所在。

    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()

创立连接

在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,注意命名空间并不会在路子中,而是在参数中传送。第3个央浼是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类型是4(message),而它的数据内容是0,表示socket.io的CONNECT。而里边的看起来乱码的局地其实是前段时间提到的payload编码中的长度的编码x00x01x00x09xffx00x02xff

  • 第四个诉求是轮询央浼,如若websocket构造建设并测试成功(使用内容为probe的ping/pong帧)后,会停顿轮询伏乞。可以看出轮询央求平昔hang住到websocket组建并测量试验成功后才再次来到,响应结果是�ÿ6,后面乱码部分是payload长度编码x00x01xff,前面包车型地铁数字6是engine.io的noop消息。

  • 第4个央求是websocket握手乞请,握手成功后,可以在chrome的Frames其间看见websocket的数额帧交互流程,能够看见如前方深入分析,确实是首发的探测帧,然后是Upgrade帧,接着正是准时的ping/pong帧了。

    2probe
    3probe
    5
    2
    3
    ...
    

长连接:

闭馆连接

客商端要积极关闭连接,在JS中调用 socket.close() 就能够,此时殡葬的多寡包为 41,个中4代表的是engine.io的音讯类型message,而数据1则是指的socket.io的音讯类型disconnect,关闭流程见上大器晚成章的申明。

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()

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的劳作流程。

(7)on_cont_message:那一个目的在收受到连年帧数据时被调用,有八个参数,分别是:类本身,从服务器选择的字符串(utf-8),再三再四标记。

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标志回显回来。

 

顾客端发送音信给服务端

假定要发送音信给服务器,在浏览器输入框输入test,点击echo按钮,能够见见websocket发送的帧的内容如下,此中4是engine.io的message类型标记,2是socket.io的EVENT类型标记,而背后则是事件名称和数量,数据能够是字符串,字典,列表等类型。

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

 

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超时而一再重连。

(6)on_close:在遇见延续关闭的场合时调用,参数唯有三个,正是此类本身。

 

ping的晚点时间,要超过ping间隔时间

 

(1)url: websocket的地址。

 

(9)keep_running:一个二进制的标记位,假若为True,那一个app的主循环将四处运作,默许值为True。

短连接:

(8)on_data:当从服务器收到到消息时被调用,有多少个参数,分别是:该类本身,选取到的字符串(utf-8),数据类型,一连标记。

(2)header: 客商发送websocket握手须求的伸手头,{'head1:value1','head2:value2'}。

——

 

(5)on_error:这一个指标在遇见错误时调用,有三个参数,第一个是此类自个儿,第三个是丰硕对象。

python websocket

作者们看源代码,会发觉这么如日中天断代码:

(4)on_message:那么些目的在收到到服务器重返的音讯时调用。有多个参数,贰个是此类本人,三个是我们从服务器获取的字符串(utf-8格式)。

 

 

 

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)

 

安装

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()

示例1:

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

 长连接,参数介绍:

pip install websocket-client

ping_timeout:如果未有选择pong消息,则为超时(秒)。

 

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

#ping_interval心跳发送间隔时间

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

先来看一下,长连接调用情势:

 

本文由9992019银河国际发布于www.9992019.com,转载请注明出处:长连接调用方式,它底层基于engine.io

关键词: