Files
i2p.itoopie/apps/sam/python/doc/epydoc/html/public/i2p.CGIHTTPServer-module.html
2004-08-02 14:00:56 +00:00

127 lines
6.6 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.CGIHTTPServer</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="i2p-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;i2p</a> ::
Module&nbsp;CGIHTTPServer
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/i2p.CGIHTTPServer-module.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="i2p.CGIHTTPServer-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module i2p.CGIHTTPServer</h2>
<p>Emulation of Python CGIHTTPServer module using I2P sockets.</p>
<p>The Python module is described at
http://www.python.org/doc/current/lib/module-CGIHTTPServer.html</p>
To get a server going, use:
<pre class="doctestblock">
<span class="py-src"><span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">from</span> i2p <span class="py-keyword">import</span> CGIHTTPServer
<span class="py-prompt">&gt;&gt;&gt; </span>CGIHTTPServer.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">&gt;&gt;&gt; </span><span class="py-keyword">from</span> i2p <span class="py-keyword">import</span> BaseHTTPServer, CGIHTTPServer
<span class="py-prompt">&gt;&gt;&gt; </span>session = <span class="py-string">&quot;mytestxxx.i2p&quot;</span> <span class="py-comment"># SAM session name</span>
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">class</span> MyServer(BaseHTTPServer.HTTPServer): <span class="py-keyword">pass</span>
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">class</span> MyRequestHandler(CGIHTTPServer.CGIHTTPRequestHandler): <span class="py-keyword">pass</span>
<span class="py-prompt">&gt;&gt;&gt; </span>httpd = MyServer(session, MyRequestHandler)
<span class="py-prompt">&gt;&gt;&gt; </span>httpd.socket.dest</span>
<span class="py-output">(Base64 Destination of server)</span>
<span class="py-src"><span class="py-prompt">&gt;&gt;&gt; </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.CGIHTTPServer.CGIHTTPRequestHandler-class.html"><code>CGIHTTPRequestHandler</code></a></b></td>
<td>Same interface as Python class
CGIHTTPServer.CGIHTTPRequestHandler.</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">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="i2p.CGIHTTPServer-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>session</span>)</span></code>
<br />
Test the HTTP CGI request handler class.</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>&lt;class&nbsp;i2p.CGIHTTPServer.CGIHTTPRequestHandler&nbsp;at&nbsp;0x00A2D...</span>,
<span class=sig-arg>ServerClass</span>=<span class=sig-default>&lt;class&nbsp;i2p.BaseHTTPServer.HTTPServer&nbsp;at&nbsp;0x00A2D960&gt;</span>,
<span class=sig-arg>session</span>=<span class=sig-default>'mytestxxx.i2p'</span>)</span>
</h3>
<p>Test the HTTP CGI 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 NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="i2p-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>