aboutsummaryrefslogtreecommitdiffstats
path: root/docs/scripting/api.rst
diff options
context:
space:
mode:
authorThomas Kriechbaumer <thomas@kriechbaumer.name>2017-12-27 21:44:10 +0100
committerThomas Kriechbaumer <thomas@kriechbaumer.name>2017-12-27 22:01:28 +0100
commitf123fb600dfae40223db44bfda9dba87d8c4eda7 (patch)
treee50e561faa2102974b7e4a290b721aeb2cae737a /docs/scripting/api.rst
parentddb8f43b87306437a8eb720072857bde1f2dcf9b (diff)
downloadmitmproxy-f123fb600dfae40223db44bfda9dba87d8c4eda7.tar.gz
mitmproxy-f123fb600dfae40223db44bfda9dba87d8c4eda7.tar.bz2
mitmproxy-f123fb600dfae40223db44bfda9dba87d8c4eda7.zip
websocket: docs++ and kill messages
fixes #2724
Diffstat (limited to 'docs/scripting/api.rst')
-rw-r--r--docs/scripting/api.rst12
1 files changed, 12 insertions, 0 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
--------