201 lines
10 KiB
HTML
201 lines
10 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>i2p.BaseHTTPServer</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
|
|
</head>
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
|
|
<!-- =========== START OF NAVBAR =========== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="center">
|
|
<th class="navbar"> <a class="navbar" href="i2p-module.html">Home</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<font size="-1"><b class="breadcrumbs">
|
|
<a href="i2p-module.html">Package i2p</a> ::
|
|
Module BaseHTTPServer
|
|
</b></font></br>
|
|
</td>
|
|
<td><table cellpadding="0" cellspacing="0">
|
|
<tr><td align="right"><font size="-2">[show private | <a href="../public/i2p.BaseHTTPServer-module.html">hide private</a>]</font></td></tr>
|
|
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="i2p.BaseHTTPServer-module.html" target="_top">no frames</a>]</font></td></tr>
|
|
</table></td>
|
|
</tr></table>
|
|
|
|
<!-- =========== START OF MODULE DESCRIPTION =========== -->
|
|
<h2 class="module">Module i2p.BaseHTTPServer</h2>
|
|
|
|
<p>Emulation of Python BaseHTTPServer module using I2P sockets.</p>
|
|
<p>The Python module is described at
|
|
http://www.python.org/doc/current/lib/module-BaseHTTPServer.html</p>
|
|
To get a server going, use:
|
|
<pre class="doctestblock">
|
|
<span class="py-src"><span class="py-prompt">>>> </span><span class="py-keyword">from</span> i2p <span class="py-keyword">import</span> BaseHTTPServer
|
|
<span class="py-prompt">>>> </span>BaseHTTPServer.test().</span></pre>
|
|
<p>Consult the documentation for function test() to change basic server
|
|
settings, such as the session name.</p>
|
|
A fully customizable example:
|
|
<pre class="doctestblock">
|
|
<span class="py-src"><span class="py-prompt">>>> </span><span class="py-keyword">from</span> i2p <span class="py-keyword">import</span> BaseHTTPServer
|
|
<span class="py-prompt">>>> </span>session = <span class="py-string">"mytestxxx.i2p"</span> <span class="py-comment"># SAM session name</span>
|
|
<span class="py-prompt">>>> </span><span class="py-keyword">class</span> MyServer(BaseHTTPServer.HTTPServer): <span class="py-keyword">pass</span>
|
|
<span class="py-prompt">>>> </span><span class="py-keyword">class</span> MyRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler): <span class="py-keyword">pass</span>
|
|
<span class="py-prompt">>>> </span>httpd = MyServer(session, MyRequestHandler)
|
|
<span class="py-prompt">>>> </span>httpd.socket.dest</span>
|
|
<span class="py-output">(Base64 Destination of server)</span>
|
|
|
|
<span class="py-src"><span class="py-prompt">>>> </span>httpd.serve_forever()</span></pre>
|
|
<hr/>
|
|
|
|
<!-- =========== START OF CLASSES =========== -->
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="summary">
|
|
<th colspan="2">Classes</th></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="i2p.BaseHTTPServer.BaseHTTPRequestHandler-class.html"><code>BaseHTTPRequestHandler</code></a></b></td>
|
|
<td>Same interface as Python class
|
|
BaseHTTPServer.BaseHTTPRequestHandler.</td></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="i2p.BaseHTTPServer.HTTPServer-class.html"><code>HTTPServer</code></a></b></td>
|
|
<td>Same interface as Python class BaseHTTPServer.HTTPServer.</td></tr>
|
|
</table><br />
|
|
|
|
|
|
<!-- =========== START OF FUNCTION SUMMARY =========== -->
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="summary">
|
|
<th colspan="2">Function Summary</th></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="i2p.BaseHTTPServer-module.html#test" class="summary-sig-name"><code>test</code></a>(<span class=summary-sig-arg>HandlerClass</span>,
|
|
<span class=summary-sig-arg>ServerClass</span>,
|
|
<span class=summary-sig-arg>protocol</span>,
|
|
<span class=summary-sig-arg>session</span>)</span></code>
|
|
<br />
|
|
Test the HTTP request handler class.</td></tr>
|
|
</table><br />
|
|
|
|
|
|
<!-- =========== START OF VARIABLE SUMMARY =========== -->
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="summary">
|
|
<th colspan="2">Variable Summary</th></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
|
|
<td><b><a href="..\private\i2p.BaseHTTPServer-module.html#__version__"><code>__version__</code></a></b> = <span title="'0.3'"><code><span class="variable-quote">'</span>0.3<span class="variable-quote">'</span> </code>
|
|
</span></td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
|
|
<td><b><a href="..\private\i2p.BaseHTTPServer-module.html#DEFAULT_ERROR_MESSAGE"><code>DEFAULT_ERROR_MESSAGE</code></a></b> = <span title="'<head>\n<title>Error response</title>\n</head>\n<body>\n<h1>Error response</h1>\n<p>Error code %(code)d.\n<p>Message: %(message)s.\n<p>Error code explanation: %(code)s = %(explain)s.\n</body>\n'"><code><span class="variable-quote">'</span><head>\n<title>Error response</<span class="variable-ellipsis">...</span></code>
|
|
</span></td></tr>
|
|
</table><br />
|
|
|
|
|
|
<!-- =========== START OF FUNCTION DETAILS =========== -->
|
|
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="details">
|
|
<th colspan="2">Function Details</th></tr>
|
|
</table>
|
|
|
|
<a name="test"></a>
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
|
<h3><span class="sig"><span class="sig-name">test</span>(<span class=sig-arg>HandlerClass</span>=<span class=sig-default><class i2p.BaseHTTPServer.BaseHTTPRequestHandler at 0x00A...</span>,
|
|
<span class=sig-arg>ServerClass</span>=<span class=sig-default><class i2p.BaseHTTPServer.HTTPServer at 0x00A2D960></span>,
|
|
<span class=sig-arg>protocol</span>=<span class=sig-default>'HTTP/1.0'</span>,
|
|
<span class=sig-arg>session</span>=<span class=sig-default>'mytestxxx.i2p'</span>)</span>
|
|
</h3>
|
|
<p>Test the HTTP request handler class.</p>
|
|
This runs an I2P TCP server under SAM session 'session'. If a single
|
|
command line argument is given, the argument is used instead as the SAM
|
|
session name.
|
|
<dl><dt></dt><dd>
|
|
</dd></dl>
|
|
</td></tr></table>
|
|
<br />
|
|
|
|
|
|
<!-- =========== START OF VARIABLE DETAILS =========== -->
|
|
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="details">
|
|
<th colspan="2">Variable Details</th></tr>
|
|
</table>
|
|
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
|
|
<a name="__version__"></a>
|
|
<h3>__version__</h3>
|
|
<dl>
|
|
<dt></dt>
|
|
<dd>
|
|
<dl>
|
|
<dt><b>Type:</b></dt>
|
|
<dd>
|
|
<code>str</code>
|
|
|
|
</dd>
|
|
<span title="'0.3'"> <dt><b>Value:</b></dt>
|
|
<dd><table><tr><td>
|
|
<pre class="variable">
|
|
<span class="variable-quote">'</span>0.3<span class="variable-quote">'</span> </pre>
|
|
</td></tr></table></dd>
|
|
</span> </dl>
|
|
</dd>
|
|
</dl></td></tr></table>
|
|
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
|
|
<a name="DEFAULT_ERROR_MESSAGE"></a>
|
|
<h3>DEFAULT_ERROR_MESSAGE</h3>
|
|
<dl>
|
|
<dt></dt>
|
|
<dd>
|
|
<dl>
|
|
<dt><b>Type:</b></dt>
|
|
<dd>
|
|
<code>str</code>
|
|
|
|
</dd>
|
|
<span title="'<head>\n<title>Error response</title>\n</head>\n<body>\n<h1>Error response</h1>\n<p>Error code %(code)d.\n<p>Message: %(message)s.\n<p>Error code explanation: %(code)s = %(explain)s.\n</body>\n'"> <dt><b>Value:</b></dt>
|
|
<dd><table><tr><td>
|
|
<pre class="variable">
|
|
<span class="variable-quote">'''</span><head>
|
|
<title>Error response</title>
|
|
</head>
|
|
<body>
|
|
<h1>Error response</h1>
|
|
<p>Error code %(code)d.
|
|
<p>Message: %(message)s.
|
|
<p>Error code explanation: %(code)s = %(explain)s.
|
|
<span class="variable-ellipsis">...</span> </pre>
|
|
</td></tr></table></dd>
|
|
</span> </dl>
|
|
</dd>
|
|
</dl></td></tr></table>
|
|
<br />
|
|
|
|
|
|
<!-- =========== START OF NAVBAR =========== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="center">
|
|
<th class="navbar"> <a class="navbar" href="i2p-module.html">Home</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr>
|
|
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Aug 02 01:07:41 2004</font></td>
|
|
<td align="right"><a href="http://epydoc.sourceforge.net"
|
|
><font size="-2">http://epydoc.sf.net</font></a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|