python
websocket

在品种中用到socket.io狠抓时推送,遂花了点时间看了socket.io完成,做个差不离分析,如有错漏,欢迎指正。

译者说

Tornado 4.3于二零一五年三月二十七日宣布,该版本正式援救Python3.5async/await主要字,并且用旧版本CPython编写翻译Tornado同样能够运用那三个根本字,那活脱脱是一种发展。其次,那是最终二个扶助Python2.6Python3.2的版本了,在再三再四的版本了会移除对它们的格外。未来网络上还从未Tornado4.3的普通话文书档案,所以为了让越多的意中人能接触并就学到它,小编起来了那几个翻译项目,希望感兴趣的伴儿能够协同参预翻译,项目地址是tornado-zh
on
Github,翻译好的文书档案在Read
the
Docs上平素能够看出。欢迎Issues
or PHaval。本节多谢@thisisx7翻译

python3知识点

jquery.min.js

金沙注册送58 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请求底部,而且在长轮询的连接实现未来,服务器端积累的新信息要等到下次客户端连接时才能传递。更好的不二法门是只用1个TCP连接来达成客户端和服务端的双向通讯,WebSocket合计正是为此而生。WebSocket是依照TCP的3个独立的磋商,它与HTTP协议的唯一涉及就是它的抓手请求可以当作三个Upgrade request路过HTTP服务器解析,且与HTTP使用相同的端口。WebSocket暗中同意对一般性请求使用80端口,协议为ws://,对TLS加密请求使用443端口,协议为wss://

拉手是通过贰个HTTP Upgrade request开班的,叁个请求和响应底部示例如下(去掉了非亲非故的底部)。WebSocket握手请求尾部与HTTP请求底部是匹配的(见酷威FC2616)。

## 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
    的值加上3个定点魔数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分别是帧的数额长度和数据内容。

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

【金沙注册送58】Tornado不难聊天室,websocket浏览器与服务器双向通讯。WebSocket 协议的兑现

WebSockets 允许浏览器和服务器之间举办 双向通讯

有着主流浏览器的现世版本都支持WebSockets(协助境况详见:http://caniuse.com/websockets)

该模块依据最新 WebSocket 协议 卡宴FC 6455 实现.

在 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(协议版本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字段来传输数据。如若客户端不援救XH路虎极光2,则payload格式如下,当中length是数据包Packet的尺寸,而packet则是编码后的数目包内容。

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

若援助XHOdyssey2,则payload中剧情全方位以二进制编码,当中第一位0表示字符串,1代表二进制数据,而背后随着的数字则是意味着packet长度,然后以\xff结尾。假诺贰个长短为109的字符类型的数据包,则前面长度编码是
\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)

通过延续该类来创建1个主题的 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 里超过50%的
HTTP 工具对于那类 handler 都以不可用的. 用来报纸发表的艺术只有write_message() , ping() , 和 close() . 同样的,你的 request handler
类里应该利用 open() 而不是 get() 可能 post()

尽管您在行使军长这些 handler 分配到 /websocket, 你能够由此如下代码完成:

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

以此剧本将会弹出四个晋升框 :”You said: Hello, world”

浏览器并从未如约同源策略(same-origin policy),相应的允许了任性站点使用
javascript 发起任意 WebSocket
连接来决定其余网络.那令人好奇,并且是叁个神秘的安全漏洞,所以 从 Tornado
4.0 开首 WebSocketHandler 供给对希望接受跨域请求的施用通过重写.

check_origin (详细音信请查看文书档案中关于该格局的局地)来展开设置.
没有正确配置那几个天性,在创制 WebSocket 连接时候很只怕会促成 403 错误.

当使用安全的 websocket 连接(wss://) 时, 来自浏览器的连天或者会失利,因为
websocket 没有位置输出 “认证成功” 的对话. 你在 websocket
连接建立成功此前,必须 使用同样的注脚访问3个平常的 HTML 页面.

 

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。

Event handlers

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

连接建立

第3,客户端会发送多个polling请求来确立连接。此时的央浼参数没有sid,表示要创设连接。
engine.io服务器通过handle_get_request()handle_post_request()艺术来分别处理开端化连接以及长轮询中的
GET 和 POST 请求。

socket.io在起先化时便登记了2个事件到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会为客户端设置1个名为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也许用其它浏览器插件来考察)。

WebSocketHandler.open(*args, **kwargs)

当打开二个新的 WebSocket 时调用

open 的参数是从 tornado.web.U昂CoraLSpec 通过正则表达式获取的, 就如获取
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()函数处理:

  • 对此轮询,一旦接收了polling的POST请求,则会调用receive往该socket的音信队列之中发送消息,从而释放以前hang住的GET请求。
  • 对于websocket:
    • 收起了ping,则会及时响应一个pong。
    • 收取到了upgrade音信,则立时发送八个noop消息。
    • 接受到了message,则调用socket.io注册到engine.io的_handle_eio_message情势来拍卖socket.io本身定义的种种信息。

WebSocketHandler.on_message(message)

拍卖在 WebSocket 中接收的音信

以此办法必须被重写

 

服务端音信发送流程

而服务端要给客户端发送消息,则须求通过socket.io服务器的emit方法,注意emit方法是本着room来发送音信的,要是是context-aware的,则emit暗中同意是对namespace为/且room名为sid的屋子发送,假如是context-free的,则私下认可是广播即对富有连接的客户端发送音信(当然在context-free的光景下边,你也足以内定room来只给钦点room推送音信)。

socket.io要兑现多进度以及广播,房间等效果,势必必要连接3个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除了探测帧之外的别的数据帧也都以通过该音信队列发送。

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小等。

一旦不是客户端主动关闭连接,socket.io就会在延续出错后连连重试以创设连接。重试间隔和重试次数由reconnectionDelayMax(默认5秒)reconnectionAttempts(暗许平素重连)设定。上面研究客户端符合规律关闭的气象,各个至极关闭状态请具体情状具体分析。

客户端主动关闭

假定客户端调用socket.close()继续努力关闭websocket连接,则会头阵送3个消息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()的原故所在。

WebSocketHandler.select_subprotocol(subprotocols)

当3个新的 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

(2)header:
客户发送websocket握手请求的伏乞头,{‘head1:value1′,’head2:value2’}。

确立连接

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

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,注意命名空间并不会在路径中,而是在参数中传送。第1个请求是polling,EIO是engine.io协议的本子号,t是三个随意字符串,第7个请求时还还没有生成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,ping提姆eout,sid等;第二个packet类型是4(message),而它的数码内容是0,表示socket.io的CONNECT。而内部的看起来乱码的某个其实是后边提到的payload编码中的长度的编码\x00\x01\x00\x09\xff\x00\x02\xff

  • 第3个请求是轮询请求,尽管websocket建立并测试成功(使用内容为probe的ping/pong帧)后,会半途而返轮询请求。可以见见轮询请求一向hang住到websocket建立并测试成功后才重临,响应结果是�ÿ6,前面乱码部分是payload长度编码\x00\x01\xff,前面包车型的士数字6是engine.io的noop音讯。

  • 第3个请求是websocket握手请求,握手成功后,能够在chrome的Frames内部来看websocket的数据帧交互流程,能够见见如前方分析,确实是头阵的探测帧,然后是Upgrade帧,接着就是定期的ping/pong帧了。

    2probe
    3probe
    5
    2
    3
    ...
    

WebSocketHandler.write_message(message, binary=False)

将付出的 message 发送到客户端

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

如若连续已经倒闭, 则会触发 WebSocketClosedError

金沙注册送58,在 3.2 版更改: 添加了 WebSocketClosedError (在前面版本会触发
AttributeError)

在 4.3 版更改: 重回能够被用于 flow control 的 Future.

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

客户端发送音信给服务端

假定要发送信息给服务器,在浏览器输入框输入test,点击echo按钮,能够看来websocket发送的帧的内容如下,个中4是engine.io的message类型标识,2是socket.io的EVENT类型标识,而前面则是事件名称和数据,数据足以是字符串,字典,列表等品种。

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

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

关闭当前 WebSocket

倘诺挥手动作成功,socket将会被关闭.

code 大概是1个数字组合的状态码, 采取 奇骏FC 6455 section 7.4.1. 定义的值.

reason 或然是描述连接关闭的文件音讯. 那么些值被提给客户端,可是不会被
WebSocket 协议单独解释.

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

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

Configuration

(5)on_error:这一个指标在碰着错误时调用,有多少个参数,第二个是此类自身,第①个是十三分对象。

服务端发送音信到客户端

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

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

WebSocketHandler.check_origin(origin)

由此重写那些格局来完成域的切换

参数 origin 的值来自 HTTP header 中的Origin,url 负责发轫化那个请求.
那些艺术并不是讲求客户端不发送那样的
heder;那样的伸手平昔被允许(因为具有的浏览器 完成的 websockets
都协助那些 header ,并且非浏览器客户端从未一样的跨域安全难点.

回到 True 代表接受,相应的回到 False 代表拒绝.暗许拒绝除 host
外其余域的请求.

其一是三个浏览器幸免 XSS 攻击的安全策略,因为 WebSocket
允许绕过平凡的同源策略 以及不利用 CO奥迪Q7S 头.

要允许全体跨域通讯的话(那在 Tornado 4.0
在此之前是私下认可的),只要简单的重写那一个办法 让它直接重回 true 就能够了:

def check_origin(self, origin):
    return True

要允许全部全数子域下的总是,可以那样实现:

def check_origin(self, origin):
    parsed_origin = urllib.parse.urlparse(origin)
    return parsed_origin.netloc.endswith(".mydomain.com")

4.0 新版作用.

(6)on_close:在遇见接二连三关闭的景观时调用,参数唯有二个,就是此类本身。

闭馆连接

客户端要积极关闭连接,在JS中调用 socket.close()
即可,此时出殡和埋葬的多寡包为
41,个中4代表的是engine.io的消息类型message,而数据1则是指的socket.io的信息类型disconnect,关闭流程见上一章的验证。

WebSocketHandler.get_compression_options()

重写该办法再次来到当前连日的 compression 选项

设若这些办法重临 None (默许), compression 将会被禁用. 若是它回到 dict
(就算 是空的),compression 都会被开启. dict 的内容将会被用来决定
compression 所 使用的内部存款和储蓄器和CPU.不过那类的设置今后还尚无被完结.

4.1 新版功用.

(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超时而不断重连。

WebSocketHandler.set_nodelay(value)

为当前 stream 设置 no-delay

在暗中认可情状下, 小块数据会被推移和/或合并以收缩发送包的数量.
那在有点时候会因为 Nagle’s 算法和 TCP ACKs 互相效能会促成 200-500ms
的延迟.在 WebSocket 连接 已经济建设立的意况下,能够由此安装
self.set_nodelay(True) 来下滑延迟(那或许 会占用越多带宽)

越来越多详细音讯: BaseIOStream.set_nodelay.

在 BaseIOStream.set_nodelay 查看详细消息.

3.1 新版功效.

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

Other

(9)keep_running:二个二进制的标志位,如若为True,这么些app的主循环将不止运转,暗中认可值为True。

WebSocketHandler.ping(data)

发送 ping 包到远端.

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

WebSocketHandler.on_pong(data)

当接受ping 包的响应时执行.

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

exception tornado.websocket.WebSocketClosedError

并发关闭连接错误触发.

3.2 新版效用.

 

Client-side support

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

tornado.websocket.websocket_connect(url, io_loop=None, callback=None, connect_timeout=None, on_message_callback=None, compression_options=None)

客户端 WebSocket 协理 需求钦赐 url, 重临2个结出为
WebSocketClientConnection 的 Future 对象

compression_options 作为 WebSocketHandler.get_compression_options 的
再次来到值, 将会以平等的法门执行.

以此延续帮忙两种类型的操作.在协程风格下,应用程序平日在1个循环里调用~.WebSocket ClientConnection.read_message:

conn = yield websocket_connect(url)
while True:
    msg = yield conn.read_message()
    if msg is None: break
    # Do something with msg

在回调风格下,要求传递 on_message_callback 到 websocket_connect 里.
在这三种风格里,三个情节是 None 的 message 都标志着 WebSocket 连接已经.

在 3.2 版更改: 允许使用 HTTPRequest 对象来顶替 urls.

在 4.1 版更改: 添加 compression_options 和 on_message_callback .

分裂情采纳 compression_options .

 假使持续开关闭websocket连接,会直接不通下去。其它那一个函数带多少个参数,要是传的话,运维心跳包发送。

class tornado.websocket.WebSocketClientConnection(io_loop, request, on_message_callback=None, compression_options=None)

WebSocket 客户端连接

那个类不应当直接被实例化, 请使用 websocket_connect

 

close(code=None, reason=None)

关闭 websocket 连接

code 和 reason 的文书档案在 WebSocketHandler.close 下已给出.

3.2 新版效率.

在 4.0 版更改: 添加 code 和 reason 那三个参数

ping_interval:自动发送“ping”命令,每一种内定的岁月(秒),若是设置为0,则不会活动发送。

write_message(message, binary=False)

发送音信到 websocket 服务器.

ping_timeout:即使没有收受pong音讯,则为超时(秒)。

read_message(callback=None)

读取来自 WebSocket 服务器的新闻.

假使在 WebSocket 初叶化时钦命了 on_message_callback
,那么那几个法子永远不会回来音信

假诺一连已经关门,重返结果会是3个结出是 message 的 future 对象恐怕是
None. 倘若 future 给出了回调参数, 那一个参数将会在 future 达成时调用.


能够透过上边二维码订阅小编的稿子公众号【Moe乐福】

金沙注册送58 2

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

 

——

相关文章

网站地图xml地图