aboutsummaryrefslogtreecommitdiffstats
path: root/docs/protocols/websocket.rst
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@corte.si>2018-02-22 20:48:17 +1300
committerGitHub <noreply@github.com>2018-02-22 20:48:17 +1300
commit443409e32bcc28a7f0475d7af42efff03473b72f (patch)
tree9d749a57929a950f0e177a9bf4d6cd7d9a88c16b /docs/protocols/websocket.rst
parent1cacefa104626e4e0df5ffb2aa8b0c6f16b615b2 (diff)
parent982508d30f887b4fe8b2a855792ae1e33f378222 (diff)
downloadmitmproxy-443409e32bcc28a7f0475d7af42efff03473b72f.tar.gz
mitmproxy-443409e32bcc28a7f0475d7af42efff03473b72f.tar.bz2
mitmproxy-443409e32bcc28a7f0475d7af42efff03473b72f.zip
Merge pull request #2890 from mitmproxy/newdocs
All new documentation
Diffstat (limited to 'docs/protocols/websocket.rst')
-rw-r--r--docs/protocols/websocket.rst22
1 files changed, 0 insertions, 22 deletions
diff --git a/docs/protocols/websocket.rst b/docs/protocols/websocket.rst
deleted file mode 100644
index 8a7e807f..00000000
--- a/docs/protocols/websocket.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-.. _websocket_protocol:
-
-WebSocket
-=========
-
-.. seealso::
-
- - `RFC6455: The WebSocket Protocol <http://tools.ietf.org/html/rfc6455>`_
- - `RFC7692: Compression Extensions for WebSocket <http://tools.ietf.org/html/rfc7692>`_
-
-WebSocket support in mitmproxy is based on the amazing work by the python-hyper
-community with the `wsproto <https://github.com/python-hyper/wsproto>`_
-project. It fully encapsulates WebSocket frames/messages/connections and
-provides an easy-to-use event-based API.
-
-mitmproxy fully supports the compression extension for WebSocket messages,
-provided by wsproto.
-
-If an endpoint sends a PING to mitmproxy, a PONG will be sent back immediately
-(with the same payload if present). To keep the other connection alive, a new
-PING (without a payload) is sent to the other endpoint. Unsolicited PONG's are
-not forwarded. All PING's and PONG's are logged (with payload if present).