diff options
author | Thomas Kriechbaumer <Kriechi@users.noreply.github.com> | 2016-09-01 10:39:57 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-09-01 10:39:57 +0200 |
commit | 55d938b880fd861a22ac66da0da9a741bdd9abd5 (patch) | |
tree | d469bbd0dd5b1966591a332bf2094d4389100219 /docs/scripting/inlinescripts.rst | |
parent | 281d779fa3eb6b81ec76d046337275c0a82eff46 (diff) | |
parent | 0d0c2c788df4b60e951e6fcc13b479de8cec22c1 (diff) | |
download | mitmproxy-55d938b880fd861a22ac66da0da9a741bdd9abd5.tar.gz mitmproxy-55d938b880fd861a22ac66da0da9a741bdd9abd5.tar.bz2 mitmproxy-55d938b880fd861a22ac66da0da9a741bdd9abd5.zip |
Merge pull request #1488 from mitmproxy/websockets
add WebSockets support
Diffstat (limited to 'docs/scripting/inlinescripts.rst')
-rw-r--r-- | docs/scripting/inlinescripts.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/scripting/inlinescripts.rst b/docs/scripting/inlinescripts.rst index bc9d5ff5..e1c01b17 100644 --- a/docs/scripting/inlinescripts.rst +++ b/docs/scripting/inlinescripts.rst @@ -126,6 +126,18 @@ HTTP Events :param HTTPFlow flow: The flow containing the error. It is guaranteed to have non-None ``error`` attribute. +WebSockets Events +^^^^^^^^^^^^^^^^^ + +.. py:function:: websockets_handshake(context, flow) + + Called when a client wants to establish a WebSockets connection. + The WebSockets-specific headers can be manipulated to manipulate the handshake. + The ``flow`` object is guaranteed to have a non-None ``request`` attribute. + + :param HTTPFlow flow: The flow containing the request which has been received. + The object is guaranteed to have a non-None ``request`` attribute. + TCP Events ^^^^^^^^^^ |