diff options
author | Aldo Cortesi <aldo@nullcube.com> | 2016-02-18 09:19:05 +1300 |
---|---|---|
committer | Aldo Cortesi <aldo@nullcube.com> | 2016-02-18 09:27:08 +1300 |
commit | 92597f82ea8e4747ce1836ecd5eb2479486e8647 (patch) | |
tree | 2aa391b558d92c0122a16c155d3375d31221cde4 /examples/stub.py | |
parent | 49464de1cb159361c16a232b3d8c267b36e95483 (diff) | |
download | mitmproxy-92597f82ea8e4747ce1836ecd5eb2479486e8647.tar.gz mitmproxy-92597f82ea8e4747ce1836ecd5eb2479486e8647.tar.bz2 mitmproxy-92597f82ea8e4747ce1836ecd5eb2479486e8647.zip |
Docs and examples to top level
Diffstat (limited to 'examples/stub.py')
-rw-r--r-- | examples/stub.py | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/examples/stub.py b/examples/stub.py new file mode 100644 index 00000000..516b71a5 --- /dev/null +++ b/examples/stub.py @@ -0,0 +1,79 @@ +""" + This is a script stub, with definitions for all events. +""" + + +def start(context, argv): + """ + Called once on script startup, before any other events. + """ + context.log("start") + + +def clientconnect(context, root_layer): + """ + Called when a client initiates a connection to the proxy. Note that a + connection can correspond to multiple HTTP requests + """ + context.log("clientconnect") + + +def request(context, flow): + """ + Called when a client request has been received. + """ + context.log("request") + + +def serverconnect(context, server_conn): + """ + Called when the proxy initiates a connection to the target server. Note that a + connection can correspond to multiple HTTP requests + """ + context.log("serverconnect") + + +def responseheaders(context, flow): + """ + Called when the response headers for a server response have been received, + but the response body has not been processed yet. Can be used to tell mitmproxy + to stream the response. + """ + context.log("responseheaders") + + +def response(context, flow): + """ + Called when a server response has been received. + """ + context.log("response") + + +def error(context, flow): + """ + Called when a flow error has occured, e.g. invalid server responses, or + interrupted connections. This is distinct from a valid server HTTP error + response, which is simply a response with an HTTP error code. + """ + context.log("error") + + +def serverdisconnect(context, server_conn): + """ + Called when the proxy closes the connection to the target server. + """ + context.log("serverdisconnect") + + +def clientdisconnect(context, root_layer): + """ + Called when a client disconnects from the proxy. + """ + context.log("clientdisconnect") + + +def done(context): + """ + Called once on script shutdown, after any other events. + """ + context.log("done") |