diff options
| author | Aldo Cortesi <aldo@nullcube.com> | 2012-02-22 17:17:13 +1300 |
|---|---|---|
| committer | Aldo Cortesi <aldo@nullcube.com> | 2012-02-22 17:17:13 +1300 |
| commit | 4f38b3a9c0dbbdf4bcd5e48386f3282263e2b5da (patch) | |
| tree | 30f98cb6dd72f5515355d97bb1cc7815f620a3a5 /doc-src/scripts.html | |
| parent | a4270efaf281dac9392f412739a6aa6fdda9a016 (diff) | |
| download | mitmproxy-4f38b3a9c0dbbdf4bcd5e48386f3282263e2b5da.tar.gz mitmproxy-4f38b3a9c0dbbdf4bcd5e48386f3282263e2b5da.tar.bz2 mitmproxy-4f38b3a9c0dbbdf4bcd5e48386f3282263e2b5da.zip | |
Documentation and screenshots.
Diffstat (limited to 'doc-src/scripts.html')
| -rw-r--r-- | doc-src/scripts.html | 40 |
1 files changed, 23 insertions, 17 deletions
diff --git a/doc-src/scripts.html b/doc-src/scripts.html index f3df489d..bea8a103 100644 --- a/doc-src/scripts.html +++ b/doc-src/scripts.html @@ -63,40 +63,46 @@ The main classes you will deal with in writing mitmproxy scripts are: <table class="kvtable"> <tr> - <th>libmproxy.flow.ScriptContext</th> - <td>A handle for interacting with mitmproxy's global state.</td> + <th>libmproxy.flow.ClientConnection</th> + <td>Describes a client connection.</td> </tr> <tr> - <th>libmproxy.flow.Flow</th> - <td>A collection of objects representing a single HTTP transaction.</td> + <th>libmproxy.flow.ClientDisconnection</th> + <td>Describes a client disconnection.</td> </tr> <tr> - <th>libmproxy.flow.Request</th> - <td>An HTTP request.</td> + <th>libmproxy.flow.Error</th> + <td>A communications error.</td> </tr> <tr> - <th>libmproxy.flow.Response</th> - <td>An HTTP response.</td> + <th>libmproxy.flow.Flow</th> + <td>A collection of objects representing a single HTTP transaction.</td> </tr> <tr> - <th>libmproxy.flow.Error</th> - <td>A communications error.</td> + <th>libmproxy.flow.Headers</th> + <td>HTTP headers for a request or response.</td> </tr> <tr> - <th>libmproxy.flow.ClientConnection</th> - <td>Describes a client connection.</td> + <th>libmproxy.flow.ODict</th> + + <td>A dictionary-like object for managing sets of key/value data. There + is also a variant called CaselessODict that ignores key case for some + calls.</td> </tr> <tr> - <th>libmproxy.flow.ClientDisconnection</th> - <td>Describes a client disconnection.</td> + <th>libmproxy.flow.Response</th> + <td>An HTTP response.</td> </tr> <tr> - <th>libmproxy.flow.Headers</th> - <td>HTTP headers for a request or response.</td> + <th>libmproxy.flow.Request</th> + <td>An HTTP request.</td> + </tr> + <tr> + <th>libmproxy.flow.ScriptContext</th> + <td>A handle for interacting with mitmproxy's global state.</td> </tr> </table> - The canonical API documentation is the code. You can view the API documentation using pydoc (which is installed with Python by default), like this: |