mirror of
https://github.com/Grasscutters/mitmproxy.git
synced 2024-11-23 08:11:00 +00:00
08895e9ba6
- restructure examples (fix #4031) - remove example dependencies from setup.py, we do not need special dependencies for our supported addons. - unify how we generate docs from code - improve example docs
38 lines
1.3 KiB
Python
38 lines
1.3 KiB
Python
"""WebSocket-specific events."""
|
|
import mitmproxy.http
|
|
import mitmproxy.websocket
|
|
|
|
|
|
class Events:
|
|
# Websocket lifecycle
|
|
def websocket_handshake(self, flow: mitmproxy.http.HTTPFlow):
|
|
"""
|
|
Called when a client wants to establish a WebSocket connection. The
|
|
WebSocket-specific headers can be manipulated to alter the
|
|
handshake. The flow object is guaranteed to have a non-None request
|
|
attribute.
|
|
"""
|
|
|
|
def websocket_start(self, flow: mitmproxy.websocket.WebSocketFlow):
|
|
"""
|
|
A websocket connection has commenced.
|
|
"""
|
|
|
|
def websocket_message(self, flow: mitmproxy.websocket.WebSocketFlow):
|
|
"""
|
|
Called when a WebSocket message is received from the client or
|
|
server. The most recent message will be flow.messages[-1]. The
|
|
message is user-modifiable. Currently there are two types of
|
|
messages, corresponding to the BINARY and TEXT frame types.
|
|
"""
|
|
|
|
def websocket_error(self, flow: mitmproxy.websocket.WebSocketFlow):
|
|
"""
|
|
A websocket connection has had an error.
|
|
"""
|
|
|
|
def websocket_end(self, flow: mitmproxy.websocket.WebSocketFlow):
|
|
"""
|
|
A websocket connection has ended.
|
|
"""
|