diff options
| author | Thomas Kriechbaumer <thomas@kriechbaumer.name> | 2017-12-27 21:44:10 +0100 |
|---|---|---|
| committer | Thomas Kriechbaumer <thomas@kriechbaumer.name> | 2017-12-27 22:01:28 +0100 |
| commit | f123fb600dfae40223db44bfda9dba87d8c4eda7 (patch) | |
| tree | e50e561faa2102974b7e4a290b721aeb2cae737a /docs/scripting | |
| parent | ddb8f43b87306437a8eb720072857bde1f2dcf9b (diff) | |
| download | mitmproxy-f123fb600dfae40223db44bfda9dba87d8c4eda7.tar.gz mitmproxy-f123fb600dfae40223db44bfda9dba87d8c4eda7.tar.bz2 mitmproxy-f123fb600dfae40223db44bfda9dba87d8c4eda7.zip | |
websocket: docs++ and kill messages
fixes #2724
Diffstat (limited to 'docs/scripting')
| -rw-r--r-- | docs/scripting/api.rst | 12 | ||||
| -rw-r--r-- | docs/scripting/events.rst | 4 |
2 files changed, 14 insertions, 2 deletions
diff --git a/docs/scripting/api.rst b/docs/scripting/api.rst index e82afef4..368b9ba8 100644 --- a/docs/scripting/api.rst +++ b/docs/scripting/api.rst @@ -10,6 +10,9 @@ API - `mitmproxy.http.HTTPRequest <#mitmproxy.http.HTTPRequest>`_ - `mitmproxy.http.HTTPResponse <#mitmproxy.http.HTTPResponse>`_ - `mitmproxy.http.HTTPFlow <#mitmproxy.http.HTTPFlow>`_ +- WebSocket + - `mitmproxy.websocket.WebSocketFlow <#mitmproxy.websocket.WebSocketFlow>`_ + - `mitmproxy.websocket.WebSocketMessage <#mitmproxy.websocket.WebSocketMessage>`_ - Logging - `mitmproxy.log.Log <#mitmproxy.controller.Log>`_ - `mitmproxy.log.LogEntry <#mitmproxy.controller.LogEntry>`_ @@ -33,6 +36,15 @@ HTTP .. autoclass:: mitmproxy.http.HTTPFlow :inherited-members: +WebSocket +--------- + +.. autoclass:: mitmproxy.websocket.WebSocketFlow + :inherited-members: + +.. autoclass:: mitmproxy.websocket.WebSocketMessage + :inherited-members: + Logging -------- diff --git a/docs/scripting/events.rst b/docs/scripting/events.rst index 9e84dacf..4d74b220 100644 --- a/docs/scripting/events.rst +++ b/docs/scripting/events.rst @@ -187,8 +187,8 @@ are issued, only new WebSocket messages are called. - Called when a WebSocket message is received from the client or server. The sender and receiver are identifiable. 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. + ``flow.messages[-1]``. The message is user-modifiable and is killable. + A message is either of TEXT or BINARY type. *flow* A ``models.WebSocketFlow`` object. |