mitmproxy/doc-src/scripts.html
2011-08-05 10:47:43 +12:00

48 lines
1.3 KiB
HTML

__mitmproxy__ has a powerful event-drive scripting API, that allows you to
modify flows on-the-fly or rewrite previously saved flows locally.
## Events
<table>
<tr>
<td>start(ctx)</td>
<td>Called once on startup, before any other events.</td>
</tr>
<tr>
<td>clientconnect(ctx, ClientConnect)</td>
<td>Called when a client initiates a connection to the proxy. Note that
a connection can correspond to multiple HTTP requests.</td>
</tr>
<tr>
<td>request(ctx, Flow)</td>
<td>Called when a client request has been received.</td>
</tr>
<tr>
<td>response(ctx, Flow)</td>
<td>Called when a server response has been received.</td>
</tr>
<tr>
<td>error(ctx, Flow)</td>
<td>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. </td>
</tr>
<tr>
<td>clientdisconnect(ctx, ClientDisconnect)</td>
<td>Called when a client disconnects from the proxy.</td>
</tr>
<tr>
<td>done(ctx)</td>
<td>Called once on script shutdown, after any other events.</td>
</tr>
</table>