菜单

Python WebSocket长连接心跳与短连接

2019年4月9日 - 皇家赌场系统

python
websocket

在品种中用到socket.io压实时推送,遂花了点时间看了socket.io实现,做个大致分析,如有错漏,欢迎指正。

译者说

Tornado 4.3于20一5年十月16日宣布,该版本正式协助Python3.5async/await重视字,并且用旧版本CPython编写翻译Tornado同样能够运用那七个至关主要字,那活脱脱是一种发展。其次,那是终极四个帮助Python2.6Python3.2的本子了,在继承的本子了会移除对它们的合营。未来网络上还不曾Tornado4.3的国语文书档案,所以为了让更多的爱侣能接触并就学到它,作者初阶了这么些翻译项目,希望感兴趣的同伙能够联手参与翻译,项目地址是tornado-zh
on
Github,翻译好的文书档案在Read
the
Docs上一向能够看到。欢迎Issues
or P奇骏。本节多谢@thisisx7翻译

python3知识点

jquery.min.js

皇家编程 1

安装

1 概述

socket.io是3个基于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的做事流程。

PS:本节最佳直接在https://tornado-zh.readthedocs.org或者http://tornado.moelove.info/阅读,以获得更加好的读书体验(格式帮衬)。原谅自个儿没排好版QAQ

web服务器代码:

#coding=utf-8

importtornado.websocket

importtornado.web

importtornado.ioloop

importdatetime

classIndexHandler(tornado.web.RequestHandler):

defget(self, *args, **kwargs):

self.render(‘templates/index.html’)

classWebHandler(tornado.websocket.WebSocketHandler):

users =set()#寄存在线用户

defopen(self, *args, **kwargs):

self.users.add(self)#把树立连接后的用户增进到用户容器中

foruserinself.users:#向在线的用户发送进入消息

user.write_message(“[%s]-[%s]-进入聊天室”%
(self.request.remote_ip,

datetime.datetime.now().strftime(“%Y-%m-%d %H:%M:%S”)))

defon_close(self):

self.users.remove(self)# 用户关闭连接后从容器中移除用户

foruserinself.users:

user.write_message(“[%s]-[%s]-离开聊天室”%
(self.request.remote_ip,

datetime.datetime.now().strftime(“%Y-%m-%d %H:%M:%S”)))

defon_message(self, message):

foruserinself.users:#向在线用户发送聊天音讯

user.write_message(“[%s]-[%s]-说:%s”% (self.request.remote_ip,

datetime.datetime.now().strftime(“%Y-%m-%d %H:%M:%S”), message))

defcheck_origin(self, origin):

return True# 允许WebSocket的跨域请求

importos

BASE_DIR = os.path.dirname(__file__)

settings = {

‘static_path’:os.path.join(BASE_DIR,’static’),

“websocket_ping_interval”:1,

“websocket_ping_timeout”:10

}

app = tornado.web.Application([(r’/’,IndexHandler),

(r’/chat’,WebHandler)],

**settings)

app.listen(8009)

tornado.ioloop.IOLoop.instance().start()


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加密请求使用44三端口,协议为wss://

握手是经过1个HTTP Upgrade request开始的,三个呼吁和响应底部示例如下(去掉了非亲非故的头顶)。WebSocket握手请求底部与HTTP请求尾部是同盟的(见讴歌RDXFC261陆)。

## 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

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 ...                :
     +---------------------------------------------------------------+

帧分为控制帧和数据帧,控制帧不能分片,数据帧能够分片。首要字段表达如下:

tornado.websocket — 浏览器与服务器双向通讯

WebSocket 协议的落到实处

WebSockets 允许浏览器和服务器之间实行 双向通讯

拥有主流浏览器的现世版本都援救WebSockets(支持景况详见:http://caniuse.com/websockets)

该模块依据最新 WebSocket 协议 宝马X3FC 645伍 实现.

在 4.0 版更改: Removed support for the draft 76 protocol version.

HTML代码:python3知识点

微信QQ

#chatcontent{

/*体现内容使用的*/

width:500px;

height:200px;

background-color:pink;

overflow-y:scroll;

overflow-x:scroll;

}

发送

ws=newWebSocket(‘ws://192.168.1.27:8009/chat’)

//服务器给浏览器推送消息的时候回调

ws.onmessage=function(p1) {

$(‘#chatcontent’).append(‘

‘+p1.data+’

‘)

}

functionsend() {

varcontent=$(‘#msg_container’).val()

ws.send(content)

$(‘#msg_container’).val(”)

}

 

3 engine.io和socket.io

眼下提到socket.io是基于engine.io的卷入,engine.io(协议版本三)有一套本身的商议,任何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是数据包,有六种档次:

而Payload是指一名目繁多绑定到1道的编码后的Packet,它只用在poll中,websocket里面使用websocket帧里面包车型地铁Payload字段来传输数据。假设客户端不帮忙XHTiggo2,则payload格式如下,当中length是数码包Packet的长度,而packet则是编码后的数量包内容。

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

若帮忙XH中华V2,则payload中内容总体以二进制编码,个中第几人0表示字符串,一表示2进制数据,而背后随着的数字则是代表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会通过自动重连机制再一次连接。

class tornado.websocket.WebSocketHandler(application, request, **kwargs)

经过持续该类来创建二个中坚的 WebSocket handler.

重写 on_message 来拍卖收到的新闻, 使用 write_message
来发送音讯到客户端. 你也足以重写 open 和 on_close
来处理连接打开和关闭那七个动作.

至于JavaScript 接口的详细音信:
http://dev.w3.org/html5/websockets/
具体的磋商:
http://tools.ietf.org/html/rfc6455

三个粗略的 WebSocket handler 的实例:
服务端间接再次来到全数接收的音信给客户端

class EchoWebSocket(tornado.websocket.WebSocketHandler):
    def open(self):
        print("WebSocket opened")

    def on_message(self, message):
        self.write_message(u"You said: " + message)

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

WebSockets 并不是正式的 HTTP 连接. “握手”动作符合 HTTP
标准,然则在”握手”动作之后, 协议是依照新闻的. 因而,Tornado 里多数的
HTTP 工具对于那类 handler 都以不可用的. 用来报纸发表的艺术只有write_message() , ping() , 和 close() . 同样的,你的 request handler
类里应该使用 open() 而不是 get() 或许 post()

1经您在行使军长以此 handler 分配到 /websocket, 你能够透过如下代码实现:

var ws = new WebSocket("ws://localhost:8888/websocket");
ws.onopen = function() {
   ws.send("Hello, world");
};
ws.onmessage = function (evt) {
   alert(evt.data);
};

其1本子将会弹出二个升迁框 :”You said: Hello, world”

浏览器并未如约同源策略(same-origin policy),相应的允许了任性站点使用
javascript 发起任意 WebSocket
连接来控制其余互连网.这令人好奇,并且是1个神秘的安全漏洞,所以 从 Tornado
肆.0 开首 WebSocketHandler 需求对愿意接受跨域请求的施用通过重写.

check_origin (详细音讯请查看文书档案中有关该办法的有的)来展开设置.
未有正确配置这些性格,在建立 WebSocket 连接时候很恐怕会导致 40三 错误.

当使用安全的 websocket 连接(wss://) 时, 来自浏览器的连天恐怕会破产,因为
websocket 未有地点输出 “认证成功” 的对话. 你在 websocket
连接建立成功以前,必须 使用同一的证件访问2个正常的 HTML 页面.

 

四 源码分析

在确立连接后,每种socket会被电动进入到3个暗中认可的命名空间/。在各种命名空间中,socket会被暗许参预多个名叫Nonesid的房间。None的屋子用于广播,而sid是当下客户端的session
id,用于单播。除暗中同意的房间外,我们得以依照需求将对应socket参与自定义房间,roomid唯一即可。socket.io基于engine.io,帮助websocket和long
polling。就算是long polling,会定时发送GET,
POST请求,当未有数据时,GET请求在拉取队列音信时会hang住(超时时间为pingTimeout),若是hang住中间服务器平昔未有数据发生,则须求等到客户端发送下3个POST请求时,此时服务器会往队列中蕴藏POST请求中的消息,那样上1个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.九.0,engine.io版本为2.0.肆。

Event handlers

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

一而再建立

先是,客户端会发送二个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事件。

客户端第三次一而再的时候,socket.io也要做1些起头化的劳作,这是在socket.io服务器的_handle_eio_connect()处理的。那里做的事体要害有几点:

末段在响应中engine.io会为客户端设置三个名称为io值为sid的cookie,响应内容payload包含五个数据包,二个是engine.io的OPEN数据包,内容为sid,pingTimeout等配备和参数;另三个是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可能用任何浏览器插件来考查)。

WebSocketHandler.open(*args, **kwargs)

当打开1个新的 WebSocket 时调用

open 的参数是从 tornado.web.U卡宴LSpec 通过正则表明式获取的, 就像是获取
tornado.web.RequestHandler.get 的参数一样

    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()函数处理:

WebSocketHandler.on_message(message)

拍卖在 WebSocket 中吸收的新闻

本条格局必须被重写

 

服务端音信发送流程

而服务端要给客户端发送音讯,则必要经过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频道,而且都有3个协程(或线程)在监听频道中是否有音信,一旦有音信,就会调用pubsub_manager._handle_emit()主意对本机对应的socket发送对应的音信,最后是因而socket.io服务器的_emit_internal()方法实现对本机中room为sid的持有socket发送消息的,假如room为None,则就是广播,即对拥有连接到本机的有着客户端推送新闻。

socket.io服务器发送音信要基于engine.io音信包装,所以总结到底还是调用的engine.io套接字中的send()情势。engine.io为每种客户端都会爱护3个音信队列,发送数据都以先存到行列之中待拉取,websocket除了探测帧之外的别的数据帧也都是通过该音讯队列发送。

WebSocketHandler.on_close()

当关闭该 WebSocket 时调用

当连接被彻底关闭并且协理 status code 或 reason phtase 的时候, 可以由此self.close_code 和 self.close_reason 那四个属性来获得它们

在 4.0 版更改: Added close_code and close_reason attributes. 添加
close_code 和 close_reason 那七个特性

 长连接,参数介绍:

闭馆连接(只分析websocket)

websocket或然非常关闭的情事多多。比如客户端发了ping后等候pong超时关闭,服务端接收到ping跟上三个ping之间超越了pingTimeout;用的uwsgi的话,uwsgi发送ping,假设在websockets-pong-tolerance(暗中认可3秒)内收纳不到pong回应,也会关闭连接;还有假使nginx的proxy_read_timeout配置的比pingInterval小等。

1经不是客户端主动关闭连接,socket.io就会在接连出错后连连重试以建立连接。重试间隔和重试次数由reconnectionDelayMax(默认5秒)reconnectionAttempts(暗许一直重连)设定。下边商讨客户端通常关闭的地方,各样相当关闭状态请具体情形具体分析。

客户端主动关闭

倘若客户端调用socket.close()继续努力关闭websocket连接,则会头阵送三个音信41(四: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为八。socket.io服务端处理格局基本一致,由于那种状态下并从未发送socket.io的倒闭新闻41,socket.io的闭馆操作供给等到engine.io触发的_handle_eio_disconnect()中拍卖,那正是前1节中为啥engine.io服务器后边还要多调用一回
_handle_eio_disconnect()的原故所在。

WebSocketHandler.select_subprotocol(subprotocols)

当二个新的 WebSocket 请求特定子协议(subprotocols)时调用

subprotocols 是多个由壹多级能够被客户端正确识别出相应的子协议
(subprotocols)的字符串构成的 list . 这一个方法或许会被重载,用来回到 list
中某 个相配字符串, 未有相称到则赶回 None.
要是未有找到相应的子协议,纵然服务端并 不会自动关闭 WebSocket
连接,不过客户端能够选用关闭连接.

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

Output

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

创立连接

在chrome中开辟页面能够看来发了2个请求,分别是:

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是3个四意字符串,第三个请求时还还尚无生成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。而内部的看起来乱码的部分其实是后边提到的payload编码中的长度的编码\x00\x01\x00\x09\xff\x00\x02\xff

WebSocketHandler.write_message(message, binary=False)

将付诸的 message 发送到客户端

message 能够是 string 也许 dict(将会被编码成 json ) 假如 binary 为
false, message 将会以 utf八 的编码发送; 在 binary 方式下 message 能够是
任何 byte string.

若是连接已经关闭, 则会触发 WebSocketClosedError

在 3.2 版更改: 添加了 WebSocketClosedError (在此前版本会触发
AttributeError)

在 四.3 版更改: 再次回到能够被用于 flow control 的 Future.

(3)on_open:在创制Websocket握手时调用的可调用对象,那一个法子唯有一个参数,就是此类自己。

客户端发送音信给服务端

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

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

WebSocketHandler.close(code=None, reason=None)

闭馆当前 WebSocket

设若挥手动作成功,socket将会被关闭.

code 恐怕是一个数字构成的状态码, 采纳 WranglerFC 6455 section 7.四.1. 概念的值.

reason 大概是讲述连接关闭的文书消息. 那几个值被提给客户端,可是不会被
WebSocket 协议单独解释.

在 4.0 版更改: Added the code and reason arguments.

(4)on_message:那几个目的在收受到服务器重回的音信时调用。有多少个参数,一个是此类本人,1个是大家从服务器获取的字符串(utf-八格式)。

服务端接收音讯流程

而服务端接收音信并赶回3个新的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()})

Configuration

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图