+
V@i D R t ^ RIt^ RIt^ RIt^ RIt^ RIt^ RIt^ RIt^ RIt^ RI t ^ RI
t
^ RI H t ^ RI
t
^ RIt^ RIHtHt ^ RIHtHtHt ^ RI
HtHtHt ^ RIHt ^ RIH t H t ^ RI H t H t ^ R I!H"t" ^ R
I
H#t# ^ R I$H%t% ^ R I&H't' ^ R
I(H)t) ^ RI*H+t+H,t,H-t-H.t.H/t/H0t0H1t1H2t2H3t3H4t4H5t5 ^ RI6H7t7 ]+' d( ^ RI8H9t9 ! R R]94 t: ! R R]94 t; ! R R]94 t`_ allow for bidirectional
communication between the browser and server. WebSockets are supported in the
current versions of all major browsers.
This module implements the final version of the WebSocket protocol as
defined in `RFC 6455 `_.
.. versionchanged:: 4.0
Removed support for the draft 76 protocol version.
N)urlparse)Future"future_set_result_unless_cancelled)utf8
native_str
to_unicode)gen
httpclienthttputil)IOLoop)StreamClosedErrorIOStream)gen_logapp_log)Resolver)simple_httpclient)Queue) TCPClient)_websocket_mask)
TYPE_CHECKINGcastAnyOptionalDictUnionList AwaitableCallableTupleType)
TracebackType)Protocolc D a ] tR t^ __static_attributes____classdictcell__r, s @r- r# r# < s r0 r# c 6 a ] tR t^Ct o RtV 3R lR ltRtV tR# )
_Decompressorr0 c , < V ^8 d QhRS[ RS[RS[ /# )r& r'
max_lengthr( )r* r< )r+ r, s "r- r. _Decompressor.__annotate__F s" 5 c e r0 c R # r2 r3 )r5 r' rJ s &&&r-
decompress_Decompressor.decompressF r8 r0 r3 N)r@ rA rB rC unconsumed_tailrM rD rE rF s @r- rH rH C s r0 rH c ~ a ] tR t^It o R
V 3R lR lltV 3R lR ltV 3R lR ltV 3R lR ltV 3R
lR ltR t V t
R# )_WebSocketDelegateNc J < V ^8 d QhRS[ S[, RS[ S[, RR/# r&
close_code close_reasonr( Nr r< str)r+ r, s "r- r. _WebSocketDelegate.__annotate__M s- &sm BJ3-
r0 c R # r2 r3 r5 rT rU s &&&r- on_ws_connection_close)_WebSocketDelegate.on_ws_connection_closeM s
r0 c J < V ^8 d QhRS[ S[S[3, RS[R, /# )r& messager( zAwaitable[None])r rW r* r )r+ r, s "r- r. rX R s* eCJ&7 HEV a ] tR t^{t o RR]R3V 3R lR lltRtV tR# )_WebSocketParamsNc | < V ^8 d QhRS[ S[, RS[ S[, RS[RS[ S[S[S[3, , RR/# )r&
ping_interval ping_timeoutmax_message_sizecompression_optionsr( N)r floatr< r rW r )r+ r, s "r- r. _WebSocketParams.__annotate__| sR
7
7
7 uo
7
7
&d38n 5
7
7r0 c 6 Wn W n W0n W@n R # r2 r r r r )r5 r r r r s &&&&&r- __init___WebSocketParams.__init__| s + ( 0 #6 r0 )r r r r )r@ rA rB rC _default_max_message_sizer rD rE rF s @r- r r { s" *.(, 98<
7
7
7r0 r c a a ] tR t^t oRtV3R lV 3R lltV3R lR lt]V3R lR l4 t]V3R lR l4 t ]V3R
lR l4 t
R1V3R lR
llt V3R lR lt ]V3R lR l4 t
V3R lR ltV3R lR ltV3R lR ltR2V3R lR lltV3R lR ltV3R lR ltV3R lR ltR3V3R lR! lltV3R" lR# ltV3R$ lR% ltV3R& lR' ltR3V3R( lR) lltV3R* lV 3R+ lltV3R, lR- ltV3R. lR/ lt R0t Vt V ;t # )4WebSocketHandleraZ Subclass this class to create a basic WebSocket handler.
Override `on_message` to handle incoming messages, and use
`write_message` to send messages to the client. You can also
override `open` and `on_close` to handle opened and closed
connections.
Custom upgrade response headers can be sent by overriding
`~tornado.web.RequestHandler.set_default_headers` or
`~tornado.web.RequestHandler.prepare`.
See http://dev.w3.org/html5/websockets/ for details on the
JavaScript interface. The protocol is specified at
http://tools.ietf.org/html/rfc6455.
Here is an example WebSocket handler that echos back all received messages
back to the client:
.. testcode::
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 are not standard HTTP connections. The "handshake" is
HTTP, but after the handshake, the protocol is
message-based. Consequently, most of the Tornado HTTP facilities
are not available in handlers of this type. The only communication
methods available to you are `write_message()`, `ping()`, and
`close()`. Likewise, your request handler class should implement
`open()` method rather than ``get()`` or ``post()``.
If you map the handler above to ``/websocket`` in your application, you can
invoke it in JavaScript with::
var ws = new WebSocket("ws://localhost:8888/websocket");
ws.onopen = function() {
ws.send("Hello, world");
};
ws.onmessage = function (evt) {
alert(evt.data);
};
This script pops up an alert box that says "You said: Hello, world".
Web browsers allow any site to open a websocket connection to any other,
instead of using the same-origin policy that governs other network
access from JavaScript. This can be surprising and is a potential
security hole, so since Tornado 4.0 `WebSocketHandler` requires
applications that wish to receive cross-origin websockets to opt in
by overriding the `~WebSocketHandler.check_origin` method (see that
method's docs for details). Failure to do so is the most likely
cause of 403 errors when making a websocket connection.
When using a secure websocket connection (``wss://``) with a self-signed
certificate, the connection from a browser may fail because it wants
to show the "accept this certificate" dialog but has nowhere to show it.
You must first visit a regular HTML page using the same certificate
to accept it before the websocket connection will succeed.
If the application setting ``websocket_ping_interval`` has a non-zero
value, a ping will be sent periodically, and the connection will be
closed if a response is not received before the ``websocket_ping_timeout``.
Both settings are in seconds; floating point values are allowed.
The default timeout is equal to the interval.
Messages larger than the ``websocket_max_message_size`` application setting
(default 10MiB) will not be accepted.
.. versionchanged:: 4.5
Added ``websocket_ping_interval``, ``websocket_ping_timeout``, and
``websocket_max_message_size``.
c l < V ^8 d QhRS[ P P RS[P RS[RR/# )r& applicationrequestkwargsr( N)tornadoweb Applicationr
HTTPServerRequestr )r+ r, s "r- r. WebSocketHandler.__annotate__ sC
&
& [[,,
& ++
&
&
&r0 c b < \ SV ` ! W3/ VB R V n R V n R V n RV n R # NF)superr
ws_connectionrT rU _on_close_called)r5 r r r __class__s &&&,r- r WebSocketHandler.__init__ s6 88 ! % r0 c * < V ^8 d QhRS[ RS[ RR/# r& argsr r( Nr )r+ r, s "r- r. r s' 2A 2As 2Ac 2Ad 2Ar0 c z " Wn W n V P P P R R4 P 4 R8w d= V P
R4 RpV P V4 \ P ! V4 R# V P P p\ R VP RR4 P R4 4 pR V9 d= V P
R4 R
pV P V4 \ P ! V4 R# R V P P 9 d' V P P P R 4 pM&V P P P R R4 pVeT V P V4 ' g= V P
R
4 RpV P V4 \ P ! V4 R# V P 4 V n V P ' d& V P P V 4 G Rj xL
R# V P
RR4 V P! RR4 R# L,5i)Upgrade websocket z"Can "Upgrade" only to "WebSocket".Nc > V P 4 P 4 # r2 )striplower)ss &r- &WebSocketHandler.get.. s aggioo'r0
Connection,upgradez "Connection" must be "Upgrade".OriginzSec-Websocket-Origini z#Cross origin websockets not allowedi zUpgrade RequiredSec-WebSocket-Versionz7, 8, 13) open_args open_kwargsr headersgetr
set_statusfinishr debugmapsplit check_originget_websocket_protocolr accept_connection
set_header)r5 r r log_msgr
connectionorigins &*, r- r WebSocketHandler.get s ! << # #Ir 2 8 8 :k I OOC :G KK MM' "
,,&& '\2)F)L)LS)Q
J & OOC 7G KK MM' " t||++ +\\))--h7F\\))--.DdKF
d&7&7&?&? OOC ;G KK MM' " ! 8 8 : $$66t< < < OOC!3 4 OO 3Z @
=s FH; A"H;. H; H9
-H;c 0 < V ^8 d QhRS[ S[, /# r& r( r r )r+ r, s "r- r. r s B Bx Br0 c : V P P RR4 # )aN The interval for sending websocket pings.
If this is non-zero, the websocket will send a ping every
ping_interval seconds.
The client will respond with a "pong". The connection can be configured
to timeout on late pong delivery using ``websocket_ping_timeout``.
Set ``websocket_ping_interval = 0`` to disable pings.
Default: ``0``
websocket_ping_intervalNsettingsr r5 s &r- r WebSocketHandler.ping_interval s }} !:DAAr0 c 0 < V ^8 d QhRS[ S[, /# r r )r+ r, s "r- r. r * s A Ahuo Ar0 c : V P P RR4 # )a Timeout if no pong is received in this many seconds.
To be used in combination with ``websocket_ping_interval > 0``.
If a ping response (a "pong") is not received within
``websocket_ping_timeout`` seconds, then the websocket connection
will be closed.
This can help to clean up clients which have disconnected without
cleanly closing the websocket connection.
Note, the ping timeout cannot be longer than the ping interval.
Set ``websocket_ping_timeout = 0`` to disable the ping timeout.
Default: equal to the ``ping_interval``.
.. versionchanged:: 6.5.0
Default changed from the max of 3 pings or 30 seconds.
The ping timeout can no longer be configured longer than the
ping interval.
websocket_ping_timeoutNr r s &r- r WebSocketHandler.ping_timeout) s . }} !94@@r0 c < V ^8 d QhRS[ /# r )r< )r+ r, s "r- r. r C s
#
r0 c B V P P R\ 4 # )zMaximum allowed message size.
If the remote peer sends a message larger than this, the connection
will be closed.
Default is 10MiB.
websocket_max_message_size)r r r r s &r- r !WebSocketHandler.max_message_sizeB s! }} (*C
r0 c Z < V ^8 d QhRS[ S[S[S[S[S[3, 3, RS[RR/# r& r^ binaryr( Future[None])r r* rW r r bool)r+ r, s "r- r. r O s> H H UCc3h 78 HBF H Hr0 c V P e! V P P 4 ' d \ 4 h\ V\ 4 ' d \
P P V4 pV P P WR7 # )a Sends the given message to the client of this Web Socket.
The message may be either a string or a dict (which will be
encoded as json). If the ``binary`` argument is false, the
message will be sent as utf8; in binary mode any byte string
is allowed.
If the connection is already closed, raises `WebSocketClosedError`.
Returns a `.Future` which can be used for flow control.
.. versionchanged:: 3.2
`WebSocketClosedError` was added (previously a closed connection
would raise an `AttributeError`)
.. versionchanged:: 4.3
Returns a `.Future` which can be used for flow control.
.. versionchanged:: 5.0
Consistently raises `WebSocketClosedError`. Previously could
sometimes raise `.StreamClosedError`.
r ) r
is_closingr|
isinstancedictr escape json_encode
write_messager5 r^ r s &&&r- r WebSocketHandler.write_messageO sh 0 %););)F)F)H)H&( ( gt $ $ nn009G!!///GGr0 c F < V ^8 d QhRS[ S[, RS[S[, /# )r& subprotocolsr( )r rW r )r+ r, s "r- r. r m s# tCy Xc] r0 c R# )a( Override to implement subprotocol negotiation.
``subprotocols`` is a list of strings identifying the
subprotocols proposed by the client. This method may be
overridden to return one of those strings to select it, or
``None`` to not select a subprotocol.
Failure to select a subprotocol does not automatically abort
the connection, although clients may close the connection if
none of their proposed subprotocols was selected.
The list may be empty, in which case this method must return
None. This method is always called exactly once even if no
subprotocols were proposed so that the handler can be advised
of this fact.
.. versionchanged:: 5.1
Previously, this method was called with a list containing
an empty string instead of an empty list if no subprotocols
were proposed by the client.
Nr3 )r5 r s &&r- select_subprotocol#WebSocketHandler.select_subprotocolm s . r0 c 0 < V ^8 d QhRS[ S[, /# r r rW )r+ r, s "r- r. r s 7 7hsm 7r0 c N V P f Q hV P P # )zIThe subprotocol returned by `select_subprotocol`.
.. versionadded:: 5.1
)r selected_subprotocolr s &r- r %WebSocketHandler.selected_subprotocol s( !!---!!666r0 c F < V ^8 d QhRS[ S[S[S[3, , /# r )r r rW r )r+ r, s "r- r. r s! $sCx.)A r0 c R# )a} Override to return compression options for the connection.
If this method returns None (the default), compression will
be disabled. If it returns a dict (even an empty one), it
will be enabled. The contents of the dict may be used to
control the following compression options:
``compression_level`` specifies the compression level.
``mem_level`` specifies the amount of memory used for the internal compression state.
These parameters are documented in detail here:
https://docs.python.org/3.13/library/zlib.html#zlib.compressobj
.. versionadded:: 4.1
.. versionchanged:: 4.5
Added ``compression_level`` and ``mem_level``.
Nr3 r s &r- get_compression_options(WebSocketHandler.get_compression_options s , r0 c J < V ^8 d QhRS[ RS[ RS[S[R, , /# r )rW r r )r+ r, s "r- r. r s+
#
)D/1J
r0 c R# )aP Invoked when a new WebSocket is opened.
The arguments to `open` are extracted from the `tornado.web.URLSpec`
regular expression, just like the arguments to
`tornado.web.RequestHandler.get`.
`open` may be a coroutine. `on_message` will not be called until
`open` has returned.
.. versionchanged:: 5.1
``open`` may be a coroutine.
Nr3 )r5 r r s &*,r- openWebSocketHandler.open s
r0 c Z < V ^8 d QhRS[ S[S[3, RS[S[R, , /# r& r^ r( Nr rW r* r r )r+ r, s "r- r. r s- " "%U
"3 "4 8Q "r0 c \ h)zHandle incoming messages on the WebSocket
This method must be overridden.
.. versionchanged:: 4.5
``on_message`` can be a coroutine.
NotImplementedErrorr` s &&r- ra WebSocketHandler.on_message s
"!r0 c : < V ^8 d QhRS[ S[S[3, RR/# rd r rW r* )r+ r, s "r- r. r s$ , ,sEz* ,T ,r0 c \ V4 pV P e! V P P 4 ' d \ 4 hV P P V4 R# )a Send ping frame to the remote end.
The data argument allows a small amount of data (up to 125
bytes) to be sent as a part of the ping message. Note that not
all websocket implementations expose this data to
applications.
Consider using the ``websocket_ping_interval`` application
setting instead of sending pings manually.
.. versionchanged:: 5.1
The data argument is now optional.
N)r r r r|
write_pingr4 s &&r- pingWebSocketHandler.ping sJ Dz %););)F)F)H)H&( ( %%d+r0 c $ < V ^8 d QhRS[ RR/# rd r) )r+ r, s "r- r. r
E
d
r0 c R# )z6Invoked when the response to a ping frame is received.Nr3 r4 s &&r- rk WebSocketHandler.on_pong r0 c $ < V ^8 d QhRS[ RR/# rd r) )r+ r, s "r- r. r r r0 c R# )z*Invoked when the a ping frame is received.Nr3 r4 s &&r- rg WebSocketHandler.on_ping r r0 c < V ^8 d QhRR/# r& r( Nr3 )r+ r, s "r- r. r s
$
r0 c R# )a0 Invoked when the WebSocket is closed.
If the connection was closed cleanly and a status code or reason
phrase was supplied, these values will be available as the attributes
``self.close_code`` and ``self.close_reason``.
.. versionchanged:: 4.0
Added ``close_code`` and ``close_reason`` attributes.
Nr3 r s &r- on_closeWebSocketHandler.on_close s
r0 c J < V ^8 d QhRS[ S[, RS[ S[, RR/# r& codereasonr( NrV )r+ r, s "r- r. r s+ & &(3- &
&QU &r0 c r V P ' d% V P P W4 RV n R# R# )a Closes this Web Socket.
Once the close handshake is successful the socket will be closed.
``code`` may be a numeric status code, taken from the values
defined in `RFC 6455 section 7.4.1
`_.
``reason`` may be a textual message about why the connection is
closing. These values are made available to the client, but are
not otherwise interpreted by the websocket protocol.
.. versionchanged:: 4.0
Added the ``code`` and ``reason`` arguments.
N)r closer5 r r s &&&r- r WebSocketHandler.close s1 $ $T 2!%D r0 c & < V ^8 d QhRS[ RS[/# )r& r r( )rW r )r+ r, s "r- r. r s 6 6 3 6 4 6 r0 c \ V4 pVP pVP 4 pV P P P R4 pW8H # )a Override to enable support for allowing alternate origins.
The ``origin`` argument is the value of the ``Origin`` HTTP
header, the url responsible for initiating this request. This
method is not called for clients that do not send this header;
such requests are always allowed (because all browsers that
implement WebSockets support this header, and non-browser
clients do not have the same cross-site security concerns).
Should return ``True`` to accept the request or ``False`` to
reject it. By default, rejects all requests with an origin on
a host other than this one.
This is a security protection against cross site scripting attacks on
browsers, since WebSockets are allowed to bypass the usual same-origin
policies and don't use CORS headers.
.. warning::
This is an important security measure; don't disable it
without understanding the security implications. In
particular, if your authentication is cookie-based, you
must either restrict the origins allowed by
``check_origin()`` or implement your own XSRF-like
protection for websocket connections. See `these
`_
`articles
`_
for more.
To accept all cross-origin traffic (which was the default prior to
Tornado 4.0), simply override this method to always return ``True``::
def check_origin(self, origin):
return True
To allow connections from any subdomain of your site, you might
do something like::
def check_origin(self, origin):
parsed_origin = urllib.parse.urlparse(origin)
return parsed_origin.netloc.endswith(".mydomain.com")
.. versionadded:: 4.0
Host)r netlocr r r r )r5 r
parsed_originhosts && r- r WebSocketHandler.check_origin sI ^ !(
%% ||##''/ ~ r0 c $ < V ^8 d QhRS[ RR/# r& ro r( Nr )r+ r, s "r- r. r 8 s . . .$ .r0 c \ V P f Q hV P P V4 R# )a Set the no-delay flag for this stream.
By default, small messages may be delayed and/or combined to minimize
the number of packets sent. This can sometimes cause 200-500ms delays
due to the interaction between Nagle's algorithm and TCP delayed
ACKs. To reduce this delay (at the expense of possibly increasing
bandwidth usage), call ``self.set_nodelay(True)`` once the websocket
connection is established.
See `.BaseIOStream.set_nodelay` for additional details.
.. versionadded:: 3.1
N)r set_nodelayr5 ro s &&r- r$ WebSocketHandler.set_nodelay8 s* !!--- &&u-r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. r I s ! !T !r0 c V P ' d" V P P 4 R V n V P ' g* RV n V P 4 V P 4 R # R # )NT)r on_connection_closer r
_break_cyclesr s &r- r) $WebSocketHandler.on_connection_closeI sV 2 2 4!%D $$$$(D ! MMO %r0 c J < V ^8 d QhRS[ S[, RS[ S[, RR/# rS rV )r+ r, s "r- r. r R - # #"3-#>Fsm#
#r0 c > Wn W n V P 4 R # r2 rT rU r) rZ s &&&r- r[ 'WebSocketHandler.on_ws_connection_closeR % ( "r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. r Y s $ $t $r0 c v < V P 4 ^e8w g V P ' d \ SV `
4 R# R# e N)
get_statusr r r* r5 r s &r- r* WebSocketHandler._break_cyclesY s/ ?? #t'<'<'< G ! # (=r0 c . < V ^8 d QhRS[ R, /# )r& r( WebSocketProtocol)r )r+ r, s "r- r. r b s
1D(E
r0 c V P P P R 4 pVR9 dI \ V P V P
V P V P 4 R7 p\ V RV4 # R# )r r FN)7813) r r r r r r r r WebSocketProtocol13)r5 websocket_versionparamss & r- r 'WebSocketHandler.get_websocket_protocolb sl LL 0 0 4 45L M 0 0% " 0 0 ! . .!%!6!6$($@$@$B F 'tUF; ;r0 c < V ^8 d QhRS[ /# r )r
)r+ r, s "r- r. r n s r0 c T R F p\ W\ 4 K V P 4 # )write)rE redirectr
set_cookier r> r )setattr#_raise_not_supported_for_websocketsdetach)r5 methods & r- _detach_stream WebSocketHandler._detach_streamn s)
F
D"E F
{{} r0 )r rT rU r r r Fr0 rv ) r@ rA rB rC r} r r propertyr r r r r r r r ra r rk rg r r r r$ r) r[ r* r rL rD rE
__classcell__r r, s @@r- r r s) N`
&
&2A 2Ah B B A A0
H H< 2 7 7 0
" ", ,*
& &(6 6 p. ."! !# #$ $
r0 r c 4 V ^8 d QhR\ R\ RR/# r r )r+ s "r- r. r. } s! ? ?s ?c ?d ?r0 c \ R 4 h)z$Method not supported for Web Sockets) RuntimeError)r r s *,r- rI rI } s
=
>>r0 c ^ a ] tR tRt o RtV 3R lR ltV 3R lR ltV 3R lR ltV 3R lR
lt] P R!V 3R lR
ll4 t ] P V 3R lR l4 t ] P V 3R lR l4 t
] P R"V 3R lR ll4 t]] P V 3R lR l4 4 t] P V 3R lR l4 t] P V 3R lR l4 t] P V 3R lR l4 t] P V 3R lR l4 t] P V 3R lR l4 tR tV tR # )#r: i z+Base class for WebSocket protocol versions.c " < V ^8 d QhRRRR/# )r& handlerrQ r( Nr3 )r+ r, s "r- r. WebSocketProtocol.__annotate__ s ' ' 4 ' 'r0 c < Wn R V n RV n RV n R # r )rX streamclient_terminatedserver_terminatedr5 rX s &&r- r WebSocketProtocol.__init__ s !& !& r0 c 0 < V ^8 d QhRS[ RS[RS[RR/# )r& callbackr r r( zOptional[Future[Any]])r r )r+ r, s "r- r. rY s- ),8; r0 c X V! V/ VB pVeN \ P ! V4 pV P f Q hV P P P VR 4 V# \
dB T P P ! \ P ! 4 ! T P 4 R# i ; i)zRuns the given callback with exception handling.
If the callback is a coroutine, returns its Future. On error, aborts the
websocket connection and returns None.
Nc " V P 4 # r2 )result)fs &r- r 1WebSocketProtocol._run_callback.. s
r0 ) r convert_yieldedr[ io_loop
add_future ExceptionrX rt sysexc_info_abort)r5 ra r r rd s &&*, r-
_run_callback WebSocketProtocol._run_callback s t.v.F ! ,,V4{{... ##..v7KLM LL & & 7 KKM s A AB)(B)c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. rY s T r0 c & V P 4 R # r2 )rm r s &r- r) %WebSocketProtocol.on_connection_close s
r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. rY s r0 c RV n RV n V P e V P P 4 V P 4 R# )z?Instantly aborts the WebSocket connection by closing the socketTN)r\ r] r[ r r s &r- rm WebSocketProtocol._abort s5 !% !% ;; " KK
r0 Nc J < V ^8 d QhRS[ S[, RS[ S[, RR/# r rV )r+ r, s "r- r. rY s+ $ $(3- $
$QU $r0 c \ 4 hr2 r r s &&&r- r WebSocketProtocol.close !##r0 c < V ^8 d QhRS[ /# r r" )r+ r, s "r- r. rY s $ $D $r0 c \ 4 hr2 r r s &r- r WebSocketProtocol.is_closing ry r0 c $ < V ^8 d QhRS[ RR/# r& rX r( Nr )r+ r, s "r- r. rY s $ $/? $D $r0 c " \ 4 h5ir2 r r^ s &&r- r #WebSocketProtocol.accept_connection !##
c Z < V ^8 d QhRS[ S[S[S[S[S[3, 3, RS[RR/# r r rW r* r r r )r+ r, s "r- r. rY s9 $ $ S%c3h 78$BF$ $r0 c \ 4 hr2 r r s &&&r- r WebSocketProtocol.write_message
"##r0 c 0 < V ^8 d QhRS[ S[, /# r r )r+ r, s "r- r. rY s $ $hsm $r0 c \ 4 hr2 r r s &r- r &WebSocketProtocol.selected_subprotocol s
"##r0 c $ < V ^8 d QhRS[ RR/# rd r) )r+ r, s "r- r. rY s $ $u $ $r0 c \ 4 hr2 r r4 s &&r- r WebSocketProtocol.write_ping ry r0 c T < V ^8 d QhRS[ S[S[3, RS[P RR/# r& keyr r( Nr rW r* r
HTTPHeaders)r+ r, s "r- r. rY s4 $ $e$$/7/C/C$
$r0 c \ 4 hr2 r )r5 r r s &&&r- _process_server_headers)WebSocketProtocol._process_server_headers r r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. rY s $ $t $r0 c \ 4 hr2 r r s &r-
start_pinging WebSocketProtocol.start_pinging ry r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. rY s $ $4 $r0 c " \ 4 h5ir2 r r s &r- _receive_frame_loop%WebSocketProtocol._receive_frame_loop r r c $ < V ^8 d QhRS[ RR/# r& xr( Nr" )r+ r, s "r- r. rY s $ $T $d $r0 c \ 4 hr2 r r5 r s &&r- r$ WebSocketProtocol.set_nodelay ry r0 )r\ rX r] r[ rv rN )r@ rA rB rC r} r rn r) rm abcabstractmethodr r r r rP r r r r r r$ rD rE rF s @r- r: r: sF 5' ' * $ $ $ $ $ $ $ $ $ $
$ $ $ $ $ $
$ $ $ $ $ $r0 r: c Z a ] tR tRt o R
V 3R lR lltV 3R lR ltV 3R lR ltR tV tR# ) _PerMessageDeflateCompressori Nc f < V ^8 d QhRS[ RS[S[, RS[S[S[S[3, , RR/# )r&
persistent max_wbitsr r( Nr r r< r rW r )r+ r, s "r- r. )_PerMessageDeflateCompressor.__annotate__ sD !$ !$!$ C=!$ &d38n 5 !$
!$r0 c Vf \ P p^Tu;8: d \ P 8: g M \ RV\ P 4 hW n Ve RV9 d+ \ P
P P V n MVR, V n Ve RV9 d ^V n MVR, V n V' d V P 4 V n R # R V n R # )N.Invalid max_wbits value %r; allowed range 8-%dcompression_level mem_level) zlib MAX_WBITS
ValueError
_max_wbitsr r GZipContentEncoding
GZIP_LEVEL_compression_level
_mem_level_create_compressor _compressor)r5 r r r s &&&&r- r %_PerMessageDeflateCompressor.__init__ s IY0$..0 @
$
'"*==&-kk&E&E&P&PD #&9:M&ND # &+=P*P DO 1+ >DO # 6 6 8D #D r0 c < V ^8 d QhRR/# )r& r( r# r3 )r+ r, s "r- r. r s
M
r0 c \ P ! V P \ P V P ) V P
4 # r2 )r compressobjr DEFLATEDr r r s &r- r /_PerMessageDeflateCompressor._create_compressor s3 # #T]]T__4Ddoo
r0 c & < V ^8 d QhRS[ RS[ /# r% r) )r+ r, s "r- r. r s U u r0 c V P ;' g V P 4 pVP V4 VP \ P
4 , pVP
R 4 ' g Q hVRR # ) N)r r r6 r> r Z_SYNC_FLUSHendswith)r5 r'
compressors && r- r6 %_PerMessageDeflateCompressor.compress sf %%BB)@)@)B
""4(:+;+;D(>
' ' '*, ,
r0 )r r r r2 ) r@ rA rB rC r r rM rD rE rF s @r- r r s# & &04 4 r0 r c a ] tR tRt o Rt^t^@t^ t^t]], ], t ^t
Rt V 3R lR lt ]
V 3R lR l4 t]P V 3R lR l4 tV 3R
lR ltV 3R lR
lt]V 3R lR l4 tV 3R lR ltV 3R lR ltV 3R lR ltV 3R lR ltR;V 3R lR lltR;V 3R lR lltRV 3R* lR+ llt!V 3R, lR- lt"V 3R. lR/ lt#]
V 3R0 lR1 l4 t$]
V 3R2 lR3 l4 t%V 3R4 lR5 lt&]V 3R6 lR7 l4 t'V 3R8 lR9 lt(R:t)V t*R# )?r? i2 zImplementation of the WebSocket protocol from RFC 6455.
This class supports versions 7 and 8 of the protocol in addition to the
final version 13.
Nc . < V ^8 d QhRRRS[ RS[RR/# )r& rX rQ
mask_outgoingrA r( N)r r )r+ r, s "r- r. WebSocketProtocol13.__annotate__C s3 !$ !$%!$ !$ ! !$
!$r0 c t \ P W4 W n W0n R V n RV n RV n RV n RV n RV n RV n
RV n VP V n
RV n RV n RV n ^ V n ^ V n ^ V n ^ V n R V n RV n RV n RV n R# )FN)r: r r rA _final_frame
_frame_opcode
_masked_frame _frame_mask
_frame_length_fragmented_message_buffer_fragmented_message_opcode_waitingr _compression_optionsr r _frame_compressed_message_bytes_in_message_bytes_out_wire_bytes_in_wire_bytes_out_received_pongrT rU _ping_coroutine)r5 rX r rA s &&&&r- r WebSocketProtocol13.__init__C s ""41 * ! ! ! !*.'*.'
$*$>$>! ! !% "# "# # # r0 c 0 < V ^8 d QhRS[ S[, /# r r )r+ r, s "r- r. r h s * *hsm *r0 c V P # r2 _selected_subprotocolr s &r- r (WebSocketProtocol13.selected_subprotocolg s )))r0 c 4 < V ^8 d QhRS[ S[, RR/# r! r )r+ r, s "r- r. r l s + +(3- +D +r0 c Wn R # r2 r r% s &&r- r r k s %*"r0 c $ < V ^8 d QhRS[ RR/# r~ r )r+ r, s "r- r. r o s /? D r0 c " V P V4 T P
T4 G Rj xL
R# \ d? TP R 4 RpTP T4 \ P
! T4 R# i ; i LR \ P d T P 4 R# \ d- \ P
! RRR7 T P 4 R# i ; i5i)r !Missing/Invalid WebSocket headersNz$Malformed WebSocket request receivedTrl )
_handle_websocket_headersr r r r r _accept_connectionasyncioCancelledErrorrm )r5 rX r s && r- r %WebSocketProtocol13.accept_connectiono s * *7 3 ))'2 2 2 s #9G NN7 # MM' "
3%% KKM MM@4 P KKM se C 1 A? A=A? C AA:6C 9A::C =A? ?%C $C 'C 0)C C C C c $ < V ^8 d QhRS[ RR/# r~ r )r+ r, s "r- r. r s B B1A Bd Br0 c ` a Rp\ \ V3R lV4 4 ' g \ R4 hR# )zzVerifies all invariant- and required headers
If a header is missing or have an incorrect value ValueError will be
raised
c N < SP P P V 4 # r2 )r r r )re rX s &r- r ?WebSocketProtocol13._handle_websocket_headers.. s !8!8!$>|$L! $ $ $,, < << 79R9R S227??3J3JK
C1v--$2K2K2W ((3q64;T;TU,A6A 78@ A 78"". ++,@#a&I ! $ ^,3 9k2<3143K3KG3TU ,,. !,,(9(9QW=P=PQK&!!! &&(((] NP " ! !3<<> 2 KKM
)sh AJ:I,,J:A$J:1 J:D J: /I3
I1I3 J:%J8& J:1I3 3>J51J:4J55J:c v < V ^8 d QhRS[ P RS[S[S[S[S[S[3, 3, , /# )r& r r( )r
r r r rW r )r+ r, s "r- r. r s: ++
eCc3h '( )r0 c VP R R4 pV' dD VP R4 Uu. uF' p\ P ! VP 4 4 NK) up# . # u upi )r r r )r r r
_parse_headerr )r5 r r# es && r- r ,WebSocketProtocol13._parse_extensions_header sW [[!;R@
?I?O?OPS?TU?T!H**17795?TU U Vs -A c T < V ^8 d QhRS[ S[S[3, RS[P RR/# r r )r+ r, s "r- r. r s9 P Pe$P/7/C/CP
Pr0 c VR, P 4 R8X g Q hVR, P 4 R8X g Q hV P V4 pVR, V8X g Q hV P V4 pV FD pV^ , R8X d* V P e V P RV^, 4 K: \ R V4 h VP
R
R4 V n R# ) z|Process the headers sent by the server to this client connection.
'key' is the websocket handshake challenge/response key.
r r r r zSec-Websocket-Acceptr Nclientzunsupported extension %rr )r r r r r r r r )r5 r r acceptr# r$ s &&& r- r +WebSocketProtocol13._process_server_headers s y!'')[888|$**, 999**3/-.&888227;
C1v--$2K2K2W((3q6: !;SAA %,KK0H$$O!r0 c
< V ^8 d QhRS[ RS[S[ S[3, RS[S[S[ S[3, , RS[S[ S[3, /# )r& sideagreed_parametersr r( rW r r r )r+ r, s "r- r. r sP S> &d38n 5
c3h r0 c \ VR, V9 R7 pVP VR, R4 pVf \ P VR& M\ V4 VR& W4R& V# )z\Converts a websocket agreed_parameters set to keyword arguments
for our compressor objects.
_no_context_takeover)r _max_window_bitsNr r )r r r r r< )r5 r2 r3 r options wbits_headers &&&& r- _get_compressor_options+WebSocketProtocol13._get_compressor_options sh 55>OO
),,T4F-FM #'>>GK #&|#4GK )<%&r0 c l < V ^8 d QhRS[ RS[S[ S[3, RS[S[S[ S[3, , RR/# )r& r2 r3 r r( Nr4 )r+ r, s "r- r. r sH
S>
&d38n 5
r0 c 0 RmpV F pWT9 g K \ RV, 4 h VR8X d RMRp\ R/ V P WV4 B V n \ RRV P
P /V P WbV4 B V n R# )server_no_context_takeoverz$unsupported compression parameter %rr r. r N> r server_max_window_bitsclient_no_context_takeoverr> r3 )r r r: r r rA r r )r5 r2 r3 r allowed_keysr
other_sides &&&& r- r 'WebSocketProtocol13._create_compressors s
%C& !G#!MNN % #'("2X
7
**4DWX
<
![[ 9 9
**/B
r0 c
6 < V ^8 d QhRS[ RS[RS[RS[RR/# )r& finopcoder' flagsr( r )r r< r* )r+ r, s "r- r. r s5 ( ( (!$ (,1 (:= ( (r0 c " \ V4 pV^, ' d& V' g \ R4 hV^}8 d \ R4 hV' d V P pM^ p\ P ! RWb, V, 4 pV P
' d ^pM^ pV^~8 d& V\ P ! RWX, 4 ,
pMTVR8: d( V\ P ! R^~V, V4 ,
pM&V\ P ! R^V, V4 ,
pV P
' d) \ P ! ^4 p V \ W4 , pWs,
pV ;P \ V4 ,
un V P P V4 # ) z$control frames may not be fragmentedz/control frame payloads may not exceed 125 bytesBi z!BHz!BQ) lenr FINstructpackr osurandomr r r[ rE )
r5 rE rF r' rG data_lenfinbitframemask_bitmasks
&&&&& r- _write_frame WebSocketProtocol13._write_frame s. t9 C<< !GHH#~ !RSS XXFF C 5!89 HH c> V[[h&9: :E
V[[hA AE V[[hA AE ::a=D/$55D
E
* {{ ''r0 c Z < V ^8 d QhRS[ S[S[S[S[S[3, 3, RS[RR/# r r )r+ r, s "r- r. r < s9 !0 !0 S%c3h 78!0BF!0 !0r0 c ` a V' d ^pM^p\ V\ 4 ' d \ P P V4 p\ P P V4 p\ V\ 4 ' g Q hV ;P \ V4 ,
un ^ pV P ' d. V P P V4 pW@P , p V P RW1VR7 oR T3R llp\ P ! T! 4 4 # \ d \ 4 hi ; i)z9Sends the given message to the client of this Web Socket.T)rG c V ^8 d QhRR/# r
r3 )r+ s "r- r. 7WebSocketProtocol13.write_message..__annotate__W s - -t -r0 c \ <" S G R j xL
R # L \ d \ 4 hi ; i5ir2 )r r| )futs r- wrapper2WebSocketProtocol13.write_message..wrapperW s)
- $
-*,,
-s , , ),)r r r r r r r* r rK r r6 RSV1rV r r| r
ensure_future)r5 r^ r rF rG r^ r] s &&& @r- r !WebSocketProtocol13.write_message< s FF gt $ $ nn009G..%%g.'5)))) 3w</ &&//8G YY E )##D&#GC - - $$WY// ! )&( ( )s D D-c $ < V ^8 d QhRS[ RR/# rd r) )r+ r, s "r- r. r _ s + +u + +r0 c \ \ V\ 4 ' g Q hV P R^ V4 R# )zSend ping frame.TN)r r* rV r4 s &&r- r WebSocketProtocol13.write_ping_ s' $&&&& $T*r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. r d s P P4 Pr0 c " V P ' g V P 4 G R j xL
K, V P P V P V P 4 R # L9 \ d T P 4 LQi ; i5ir2 )r\ _receive_framer rm rX r[ rT rU r s &r- r 'WebSocketProtocol13._receive_frame_loopd si ,,,))+++ -
++DOOT=N=NO , KKM s< BA% A% A#A% 3B#A% %B BBBc & < V ^8 d QhRS[ RS[/# )r& nr( r; )r+ r, s "r- r. r l s 3 5 r0 c " V P P V4 G R j xL
pV ;P V,
un V# L 5ir2 )r[
read_bytesr )r5 rk r' s && r- _read_bytes WebSocketProtocol13._read_bytesl s7 [[++A.. q /s AA Ac < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. r q s Q% Q%d Q%r0 c " V P ^4 G Rj xL
p\ P ! RV4 w r#W P , pW P , pW P
, pV^, pV P e; V^ 8w d4 \ WPP , 4 V n WPP ( , pV' d V P 4 R# \ V^, 4 pV^, p V' d V ^~8 d V P 4 R# V ^~8 d Wn M}V ^~8X d9 V P ^4 G Rj xL
p\ P ! RV4 ^ , p M>V ^8X d8 V P ^4 G Rj xL
p\ P ! RV4 ^ , p T p
V P e V
\ V P 4 ,
p
WP P 8 d% V P! RR4 V P 4 R# V' d V P ^4 G Rj xL
V n V P V 4 G Rj xL
pV' d' V P" f Q h\% V P" V4 pV' d V' g V P 4 R# MV^ 8X dm V P f V P 4 R# V P P' V4 V' d) V P( p\+ V P 4 pRV n M>V P e V P 4 R# V' g W`n \- V4 V n V' d$ V P/ Wa4 p V e
V G Rj xL
R# R# R# EL^ EL= EL EL[ EL@ L5i)r& NBBz!Hz!Q zmessage too big)rn rM unpackrL RSV_MASK OPCODE_MASKr r r` r rm r r rK rA r r r r extendr r* bytearray_handle_message) r5 r' headermask_payloadlenis_final_frame
reserved_bitsrF opcode_is_control is_masked
payloadlennew_lenhandled_futures & r- rh "WebSocketProtocol13._receive_frameq s %%a(("(--d"; ((* .
*** "SL )fk &*-))*C%DD " iiZ 'M KKM 4/0 $t+
s!2 KKM !+
3
))!,,D tT215J
3
))!,,D tT215J * * 6 s4::; ;G [[11 1 JJt . / KKM %)%5%5a%8 8D %%j11 ##/ //"4#3#3T:D "
" q[..6
+ + 2 24 8 88 T < <=26/..:
!28/2;D// ! 1 1& ?N )$$$ * Y )6 - - 91H %s NM5B+NA7N;M8<>N:M;;BNN#M>$ NN N-N<NA N!AN2 NN*N+ N8N;N>NNNc * < V ^8 d QhRS[ RS[RR/# )r& rF r' r( zOptional[Future[None]]r; )r+ r, s "r- r. r s# 1 1c 1 1;S 1r0 c V P ' d R# V P ' d- V P f Q h V P P V4 pV^8X d[ V ;P \ V4 ,
un VP R4 pT P T P P T4 # V^8X dI V ;P \ V4 ,
un V P V P P V4 # V^8X d RV n \ V4 ^8 d+ \ P ! RVR, 4 ^ , V n \ V4 ^8 d \# VR, 4 V n V P V P 4 R# V^ 8X d= V P' R^
V4 V P V P P* V4 R# V^
8X d. RV n V P V P P. V4 # V P
4 R# \ d' T P RR4 T P
4 R# i ; i \ d T P
4 R# i ; i \( d T P
4 Li ; i) z>Execute on_message, returning its Future if it is a coroutine.Nrs z#message too big after decompressionzutf-8T>H:Nr& N:r& NN)r\ r r rM r r rm r rK decodeUnicodeDecodeErrorrn rX ra rM rt rT r rU rV r rg r rk )r5 rF r' decodeds &&& r- ry #WebSocketProtocol13._handle_message s ! ! ! ! ! !%%1 11
))44T: S= " "c$i / "
++g. %%dll&=&=wG G
s] " "c$i / "%%dll&=&=tD D
s]%)D "4yA~"(--d2h"?"B4y1}$.tBx$8! JJt ' s]
!!$T2
t|| 3 3T :
s]"&D %%dll&:&:DA A KKMQ ,
4!FG
&
* %
s5 H =I I. -I I I+*I+.J J c J < V ^8 d QhRS[ S[, RS[ S[, RR/# r rV )r+ r, s "r- r. r s+ ( ((3- (
(QU (r0 c V P ' gz V P P 4 ' gS Vf Ve RpVf RpM\ P ! RV4 pVe V\ V4 ,
p V P
R^V4 RV n V P ' d` V P e7 V P P P V P 4 RV n
V P P 4 MlV P f_ V P P P V P P P 4 ^, V P 4 V n
V P ' d$ V P P# 4 RV n R# R# \ d T P 4 EL9i ; i)z Closes the WebSocket connection.Ni r0 r T)r] r[ closedrM rN r rV r rm r\ r rh remove_timeoutr add_timeouttimer cancel)r5 r r
close_datas &&& r- r WebSocketProtocol13.close sX %%%;;%%''F?c < V ^8 d QhRS[ /# r r" )r+ r, s "r- r. r s X XD Xr0 c V P P 4 ;' g! V P ;' g
V P # )zReturn ``True`` if this connection is closing.
The connection is considered closing if either side has
initiated its closing handshake or if the stream has been
shut down uncleanly.
)r[ r r\ r] r s &r- r WebSocketProtocol13.is_closing s3 {{!!#WWt'='=WWAWAWWr0 c $ < V ^8 d QhRS[ RR/# r r" )r+ r, s "r- r. r s # #T #d #r0 c < V P P V4 R # r2 )r[ r$ r s &&r- r$ WebSocketProtocol13.set_nodelay s "r0 c < V ^8 d QhRS[ /# r r )r+ r, s "r- r. r $ s u r0 c > V P P pVe V# ^ # r2 )rA r )r5 intervals & r- r !WebSocketProtocol13.ping_interval# s ;;,, Or0 c < V ^8 d QhRS[ /# r r )r+ r, s "r- r. r + s " "e "r0 c V P P pVeh V P ' dT WP 8 dD \ \ P
RV RV P RV P 24 V P # V# V P # )Nz The websocket_ping_timeout (z5) cannot be longer than the websocket_ping_interval (z").
Setting websocket_ping_timeout=)rA r r de_dupe_gen_logloggingWARNING)r5 timeouts & r- r WebSocketProtocol13.ping_timeout* s ++** !!!g0B0B&B OO27) <::>:L:L9M N88<8J8J7KM )))N!!!r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. r ; s M Mt Mr0 c V P ' g? V P ^ 8 d, \ P ! V P 4 4 V n R# R# R# )z9Start sending periodic pings to keep the connection aliveN)r r r create_task
periodic_pingr s &r- r !WebSocketProtocol13.start_pinging; sD $$$""Q&#*#6#6t7I7I7K#LD ' %r0 c 2 < V ^8 d QhRS[ RS[ RS[ RS[ /# )r& last_ping_timer nowr( r )r+ r, s "r- r. r F s* 7 75 7E 7 7RW 7r0 c 4 \ ^ W, V,
4 # )z r r z*permessage-deflate; client_max_window_bitsr F)r c R # r2 r3 r3 r0 r- r 4WebSocketClientConnection.__init__.. s Dr0 i @i )r connect_futurer
read_queuer r rO rP r _on_message_callbackrT rU r rA url partitionr r
r joinfollow_redirectsr
tcp_clientr r _on_http_response)
r5 r r r r r r r r schemeseprestr s
&&&&&&&&& r- r "WebSocketClientConnection.__init__u sP %h (##BJJrN3$7! &'% - 3
$KK 1 1# 6Tw/7 lT) ; i#Z%9'
#8; 8NGOO 4 5 * =
OO 6 7
$) #X6
" " OO
r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. r s Q Q Qr0 c \ V P e \ P ! R\ 4 R # R # )Nz"Unclosed WebSocketClientConnection)protocolwarningswarnResourceWarningr s &r- __del__!WebSocketClientConnection.__del__ s" == $
MM> P
%r0 c J < V ^8 d QhRS[ S[, RS[ S[, RR/# r rV )r+ r, s "r- r. r s+ ! !(3- !
!QU !r0 c j V P e% V P P W4 RV n R# R# )zCloses the websocket connection.
``code`` and ``reason`` are documented under
`WebSocketHandler.close`.
.. versionadded:: 3.2
.. versionchanged:: 4.0
Added the ``code`` and ``reason`` arguments.
N)r r r s &&&r- r WebSocketClientConnection.close s, == $ MM - DM %r0 c < V ^8 d QhRR/# r
r3 )r+ r, s "r- r. r s & &T &r0 c < V P P 4 ' g$ V P P \ 4 4 V P R 4 V P
P
4 \ SV `! 4 R # r2 ) r done
set_exceptionr _on_messager r r r) r7 s &r- r) -WebSocketClientConnection.on_connection_close sY ""'')) - -.?.A B
#%r0 c J < V ^8 d QhRS[ S[, RS[ S[, RR/# rS rV )r+ r, s "r- r. r r- r0 c > Wn W n V P 4 R # r2 r/ rZ s &&&r- r[ 0WebSocketClientConnection.on_ws_connection_close r1 r0 c 8 < V ^8 d QhRS[ P RR/# )r& responser( N)r HTTPResponse)r+ r, s "r- r. r s! **A*A d r0 c V P P 4 ' g` VP ' d( V P P VP 4 R# V P P \ R 4 4 R# R# )zNon-websocket responseN)r r errorr rx )r5 r s &&r- r +WebSocketClientConnection._on_http_response sZ ""''))~~~##11(..A##11"#;< *r0 c | < V ^8 d QhRS[ S[P S[P 3, RS[P RR/# )r&
start_liner r( N)r r
RequestStartLineResponseStartLiner )r+ r, s "r- r. r sJ F F(33X5O5OOP F %% F
Fr0 c <" \ V\ P 4 ' g Q hVP ^e8w d \ SV ` W4 G Rj xL
R# V P e- V P P V P 4 RV n W n V P 4 V n V P P V P V P 4 V P P 4 V P n \" P$ ! 4 P' V P P( 4 V P P+ 4 RV n \/ V P0 V 4 R# EL&5ir4 )r r
r r r headers_received_timeoutrh r r r r r r r rJ r[ r r add_callbackr r final_callbackr r )r5 r r r s &&&r- r *WebSocketClientConnection.headers_received s
*h&@&@AAAA ??c !'*:? ? ? == $ LL ' '
6 DM 335
--dhh E # 5 5 7
%%dmm&G&GH
##% #*4+>+>E+
@s AE2 E/
D&E2c Z < V ^8 d QhRS[ S[S[S[S[S[3, 3, RS[RR/# r r )r+ r, s "r- r. r s> C C S%c3h 78CBFC Cr0 c l V P f \ R4 hV P P WR7 # )a Sends a message to the WebSocket server.
If the stream is closed, raises `WebSocketClosedError`.
Returns a `.Future` which can be used for flow control.
.. versionchanged:: 5.0
Exception raised on a closed stream changed from `.StreamClosedError`
to `WebSocketClosedError`.
z!Client connection has been closedr )r r| r r s &&&r- r 'WebSocketClientConnection.write_message s2 == &'JK K}}**7*BBr0 c r < V ^8 d QhRS[ S[R.R3, , RS[S[RS[S[3, , /# )r& ra z Future[Union[None, str, bytes]]Nr( )r r r r rW r* )r+ r, s "r- r. r sC 8%F$G$MNO
5sE)* +r0 c V P P 4 pVe1 V P P \ P
! V4 V4 V# )a@ Reads a message from the WebSocket server.
If on_message_callback was specified at WebSocket
initialization, this function will never return messages
Returns a future whose result is the message, or None
if the connection is closed. If a callback argument
is given it will be called with the future when it is
ready.
)r r rh ri r ra )r5 ra awaitables && r- read_message&WebSocketClientConnection.read_message sA OO'') LL # #G$9$9)$Dh Or0 c Z < V ^8 d QhRS[ S[S[3, RS[S[R, , /# r r )r+ r, s "r- r. r % s- ) )%U
"3 )4 8Q )r0 c $ V P V4 # r2 )r r` s &&r- ra $WebSocketClientConnection.on_message% s ((r0 c \ < V ^8 d QhRS[ RS[S[3, RS[S[R, , /# )r& r^ Nr( r )r+ r, s "r- r. r ( s2 0 0 T3 -.0 )D/ "0r0 c V P ' d V P V4 R # V P P V4 # r2 )r r putr` s &&r- r %WebSocketClientConnection._on_message( s6 $ $ $ % %g .??&&w/ /r0 c $ < V ^8 d QhRS[ RR/# rd r) )r+ r, s "r- r. r 1 s ' ' ' 'r0 c \ V4 pV P f \ 4 hV P P V4 R# )a_ Send ping frame to the remote end.
The data argument allows a small amount of data (up to 125
bytes) to be sent as a part of the ping message. Note that not
all websocket implementations expose this data to
applications.
Consider using the ``ping_interval`` argument to
`websocket_connect` instead of sending pings manually.
.. versionadded:: 5.1
N)r r r| r r4 s &&r- r WebSocketClientConnection.ping1 s2 Dz == &( (
&r0 c $ < V ^8 d QhRS[ RR/# rd r) )r+ r, s "r- r. r D
E
d
r0 c R # r2 r3 r4 s &&r- rk !WebSocketClientConnection.on_pongD r0 c $ < V ^8 d QhRS[ RR/# rd r) )r+ r, s "r- r. r G r r0 c R # r2 r3 r4 s &&r- rg !WebSocketClientConnection.on_pingG r r0 c < V ^8 d QhRS[ /# r )r: )r+ r, s "r- r. r J s Q Q(9 Qr0 c 2 \ V R V P R7 # )T)r rA )r? rA r s &r- r 0WebSocketClientConnection.get_websocket_protocolJ s "4tDKKPPr0 c 0 < V ^8 d QhRS[ S[, /# r r )r+ r, s "r- r. r N s 2 2hsm 2r0 c . V P P # )z?The subprotocol selected by the server.
.. versionadded:: 5.1
)r r r s &r- r .WebSocketClientConnection.selected_subprotocolM s }}111r0 c N < V ^8 d QhRRRS[ S[, RS[ S[, RR/# )r& rn z Optional[Type[BaseException]]ro rp r( N)r rq r )r+ r, s "r- r. r U sC Q Q
,Q
&Q
] # Q
Qr0 c R Vf Q hVf Q h\ P ! RW!W#3R7 R # )NzUncaught exception %sr )r r rs s &&&&r- rt 'WebSocketClientConnection.log_exceptionU s.
-uU?OPr0 ) r r rT rU r r r r rA r r r rv rN r2 rO ) r@ rA rB rC r} r r r r r r) r[ r r r r ra r r rk rg r rP r rt rD rE rQ rR s @@r- r r l s H
TX8<)-(, 9,0'+<
<
|Q Q! ! & &# # F F<C C () )0 0' '&
Q Q 2 2Q Q Qr0 r c V ^8 d QhR\ \ \ P 3, R\ \
R.R3, , R\ \ , R\ \
\ R\ \ 3, .R3, , R\ \ \ \ 3, , R\ \ , R \ \ , R
\ R \ \ \ , , R \ \ , R
R/ # )r& r ra z!Future[WebSocketClientConnection]Nconnect_timeoutr r r r r r r r( z$Awaitable[WebSocketClientConnection])
r rW r r r r r r* r r r< r r )r+ s "r- r. r. ` s ] ] sJ*** +] x!D Et KLM] e_] "(E$U2B,C+Dd+J"KL ]
"$sCx.1 ] E?
] 5/] ] 49%] x ] ,] r0 c
8 \ V \ P 4 ' d/ Ve Q hT p
\ P ! V
P
4 V
n M\ P ! WR7 p
\
\ P \ P ! V
\ P P 4 4 p
\ V
VVVVVVV R7 p VeM \ P ! R\ ^R7 \ P ! 4 P V P V4 V P # )a Client-side websocket support.
Takes a url and returns a Future whose result is a
`WebSocketClientConnection`.
``compression_options`` is interpreted in the same way as the
return value of `.WebSocketHandler.get_compression_options`.
The connection supports two styles of operation. In the coroutine
style, the application typically calls
`~.WebSocketClientConnection.read_message` in a loop::
conn = yield websocket_connect(url)
while True:
msg = yield conn.read_message()
if msg is None: break
# Do something with msg
In the callback style, pass an ``on_message_callback`` to
``websocket_connect``. In both styles, a message of ``None``
indicates that the connection has been closed.
``subprotocols`` may be a list of strings specifying proposed
subprotocols. The selected protocol may be found on the
``selected_subprotocol`` attribute of the connection object
when the connection is complete.
.. versionchanged:: 3.2
Also accepts ``HTTPRequest`` objects in place of urls.
.. versionchanged:: 4.1
Added ``compression_options`` and ``on_message_callback``.
.. versionchanged:: 4.5
Added the ``ping_interval``, ``ping_timeout``, and ``max_message_size``
arguments, which have the same meaning as in `WebSocketHandler`.
.. versionchanged:: 5.0
The ``io_loop`` argument (deprecated since version 4.1) has been removed.
.. versionchanged:: 5.1
Added the ``subprotocols`` argument.
.. versionchanged:: 6.3
Added the ``resolver`` argument.
.. deprecated:: 6.5
The ``callback`` argument is deprecated and will be removed in Tornado 7.0.
Use the returned Future instead. Note that ``on_message_callback`` is not
deprecated and may still be used.
)r# )r r r r r r r zZThe callback argument to websocket_connect is deprecated. Use the returned Future instead.)
stacklevel)r r r r
r r r
_RequestProxy _DEFAULTSr r r DeprecationWarningr r ri r ) r ra r# r r r r r r r r conns &&&&&&&&&& r- websocket_connectr* ` s ~ #z--.. &&& #..w? ((N **@*@*J*JKG % / /#!)! D
/
##D$7$7B r0 i )Rr} r r r functoolsr r rO rk rM r urllib.parser r r tornado.concurrentr r tornado.escaper r r r r r
tornado.ioloopr tornado.iostreamr r
tornado.logr r tornado.netutilr r tornado.queuesr tornado.tcpclientr tornado.utilr typingr r r r r r r r r r r typesr typing_extensionsr! r# rH rQ r lru_cachelogr rj rx r| r r r RequestHandlerr rI ABCr: r r r? _HTTPConnectionr r* r3 r0 r- r> s
! I 7 7 - - ! 8 ( $ % ' ( *h X 6 - %%gkk2 Y > y 7 7 q w{{11 q h?X$ X$v- -`# #Lw+ wtqQ 1 A A qQl QU'+OS48%)$( 5(,#'] ] r0