U
|
[ ±d+ ã @ s d Z ddlmZ ddlmZmZ ddlmZmZm Z m
|
Z
|
m Z m Z ddl mZ ddlmZ G dd d eZed
|
d G d d d eZed
|
d G dd deZed
|
d G dd deZed
|
d G dd deZed
|
d G dd deZe deeZed
|
d G dd deee Zed
|
d G dd dee Zed
|
d G dd d ee Zed
|
d G d d d eZ ed
|
d G d d d eZ d!S )"zc
|
wsproto/events
|
~~~~~~~~~~~~~~
|
|
Events that result from processing data on a WebSocket connection.
|
é )ÚABC)Ú dataclassÚfield)ÚGenericÚListÚOptionalÚSequenceÚTypeVarÚUnioné )Ú Extension)ÚHeadersc @ s e Zd ZdZdS )ÚEventz(
|
Base class for wsproto events.
|
N)Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__© r r úEd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\wsproto/events.pyr s r T)Úfrozenc @ sl e Zd ZU dZeed< eed< eedZe e
|
e e
|
e f ed< eedZ e ed< eedZee ed< dS ) ÚRequesta¿ The beginning of a Websocket connection, the HTTP Upgrade request
|
|
This event is fired when a SERVER connection receives a WebSocket
|
handshake request (HTTP with upgrade header).
|
|
Fields:
|
|
.. attribute:: host
|
|
(Required) The hostname, or host header value.
|
|
.. attribute:: target
|
|
(Required) The request target (path and query string)
|
|
.. attribute:: extensions
|
|
The proposed extensions.
|
|
.. attribute:: extra_headers
|
|
The additional request headers, excluding extensions, host, subprotocols,
|
and version headers.
|
|
.. attribute:: subprotocols
|
|
A list of the subprotocols proposed in the request, as a list
|
of strings.
|
ÚhostÚtarget©Údefault_factoryÚ
|
extensionsÚ extra_headersÚ subprotocolsN)r r r r ÚstrÚ__annotations__r Úlistr r
|
r r r r r r r r r r r s
|
ÿ r c @ sJ e Zd ZU dZdZee ed< ee dZ
|
e e ed< ee dZ eed< dS )ÚAcceptConnectiona² The acceptance of a Websocket upgrade request.
|
|
This event is fired when a CLIENT receives an acceptance response
|
from a server. It is also used to accept an upgrade request when
|
acting as a SERVER.
|
|
Fields:
|
|
.. attribute:: extra_headers
|
|
Any additional (non websocket related) headers present in the
|
acceptance response.
|
|
.. attribute:: subprotocol
|
|
The accepted subprotocol to use.
|
|
NÚ subprotocolr r r )r r r r r" r r r r r r r r r r r r r r r! @ s
|
r! c @ s< e Zd ZU dZdZeed< eedZ e
|
ed< dZ e ed< dS ) ÚRejectConnectiona´ The rejection of a Websocket upgrade request, the HTTP response.
|
|
The ``RejectConnection`` event sends the appropriate HTTP headers to
|
communicate to the peer that the handshake has been rejected. You may also
|
send an HTTP body by setting the ``has_body`` attribute to ``True`` and then
|
sending one or more :class:`RejectData` events after this one. When sending
|
a response body, the caller should set the ``Content-Length``,
|
``Content-Type``, and/or ``Transfer-Encoding`` headers as appropriate.
|
|
When receiving a ``RejectConnection`` event, the ``has_body`` attribute will
|
in almost all cases be ``True`` (even if the server set it to ``False``) and
|
will be followed by at least one ``RejectData`` events, even though the data
|
itself might be just ``b""``. (The only scenario in which the caller
|
receives a ``RejectConnection`` with ``has_body == False`` is if the peer
|
violates sends an informational status code (1xx) other than 101.)
|
|
The ``has_body`` attribute should only be used when receiving the event. (It
|
has ) is False the headers must include a
|
content-length or transfer encoding.
|
|
Fields:
|
|
.. attribute:: headers (Headers)
|
|
The headers to send with the response.
|
|
.. attribute:: has_body
|
|
This defaults to False, but set to True if there is a body. See
|
also :class:`~RejectData`.
|
|
.. attribute:: status_code
|
|
The response status code.
|
|
i Ú status_coder ÚheadersFÚhas_bodyN) r r r r r$ Úintr r r r% r r& Úboolr r r r r# Z s
|
% r# c @ s& e Zd ZU dZeed< dZeed< dS )Ú
|
RejectDataaa The rejection HTTP response body.
|
|
The caller may send multiple ``RejectData`` events. The final event should
|
have the ``body_finished`` attribute set to ``True``.
|
|
Fields:
|
|
.. attribute:: body_finished
|
|
True if this is the final chunk of the body data.
|
|
.. attribute:: data (bytes)
|
|
(Required) The raw body data.
|
|
ÚdataTÚ body_finishedN)r r r r Úbytesr r+ r( r r r r r) s
|
r) c @ s8 e Zd ZU dZeed< dZee ed< d dddZ dS )ÚCloseConnectiona The end of a Websocket connection, represents a closure frame.
|
|
**wsproto does not automatically send a response to a close event.** To
|
comply with the RFC you MUST send a close event back to the remote WebSocket
|
if you have not already sent one. The :meth:`response` method provides a
|
suitable event for this purpose, and you should check if a response needs
|
to be sent by checking :func:`wsproto.WSConnection.state`.
|
|
Fields:
|
|
.. attribute:: code
|
|
(Required) The integer close code to indicate why the connection
|
has closed.
|
|
.. attribute:: reason
|
|
Additional reasoning for why the connection has closed.
|
|
ÚcodeNÚreason©Úreturnc C s t | j| jdS )z?Generate an RFC-compliant close frame to send back to the peer.)r. r/ )r- r. r/ ©Úselfr r r Úresponse¸ s zCloseConnection.response)
|
r r r r r' r r/ r r r4 r r r r r- s
|
r- ÚTc @ s2 e Zd ZU dZeed< dZeed< dZeed< dS )ÚMessagea¾ The websocket data message.
|
|
Fields:
|
|
.. attribute:: data
|
|
(Required) The message data as byte string, can be decoded as UTF-8 for
|
TEXT messages. This only represents a single chunk of data and
|
not a full WebSocket message. You need to buffer and
|
reassemble these chunks to get the full message.
|
|
.. attribute:: frame_finished
|
|
This has no semantic content, but is provided just in case some
|
weird edge case user wants to be able to reconstruct the
|
fragmentation pattern of the original stream.
|
|
.. attribute:: message_finished
|
|
True if this frame is the last one of this message, False if
|
more frames are expected.
|
|
r* TÚframe_finishedÚmessage_finishedN) r r r r r5 r r7 r( r8 r r r r r6 À s
|
r6 c @ s e Zd ZU dZeed< dS )Ú TextMessagea9 This event is fired when a data frame with TEXT payload is received.
|
|
Fields:
|
|
.. attribute:: data
|
|
The message data as string, This only represents a single chunk
|
of data and not a full WebSocket message. You need to buffer
|
and reassemble these chunks to get the full message.
|
|
r* N)r r r r r r r r r r r9 ß s
|
r9 c @ s e Zd ZU dZeed< dS )Ú BytesMessageav This event is fired when a data frame with BINARY payload is
|
received.
|
|
Fields:
|
|
.. attribute:: data
|
|
The message data as byte string, can be decoded as UTF-8 for
|
TEXT messages. This only represents a single chunk of data and
|
not a full WebSocket message. You need to buffer and
|
reassemble these chunks to get the full message.
|
r* N)r r r r r, r r r r r r: ñ s
|
r: c @ s, e Zd ZU dZdZeed< ddddZdS ) ÚPinga« The Ping event can be sent to trigger a ping frame and is fired
|
when a Ping is received.
|
|
**wsproto does not automatically send a pong response to a ping event.** To
|
comply with the RFC you MUST send a pong even as soon as is practical. The
|
:meth:`response` method provides a suitable event for this purpose.
|
|
Fields:
|
|
.. attribute:: payload
|
|
An optional payload to emit with the ping frame.
|
ó ÚpayloadÚPongr0 c C s t | jdS )z>Generate an RFC-compliant :class:`Pong` response to this ping.)r= )r> r= r2 r r r r4 s z Ping.responseN)r r r r r= r, r r4 r r r r r; s
|
r; c @ s e Zd ZU dZdZeed< dS )r> zThe Pong event is fired when a Pong is received.
|
|
Fields:
|
|
.. attribute:: payload
|
|
An optional payload to emit with the pong frame.
|
|
r< r= N)r r r r r= r, r r r r r r> s
|
|
r> N) r Úabcr Z dataclassesr r Útypingr r r r r r
|
r r r r r r! r# r) r- r, r r5 r6 r9 r: r; r> r r r r Ú<module> s6 (+
|
