twisted.web.server.Site.html [plain text]
<?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>twisted.web.server.Site</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="twisted.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" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.web.html">Package web</a> ::
<a href="twisted.web.server.html">Module server</a> ::
Class Site
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.server.Site.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Site</h2>
<pre class="base-tree">
<a href="twisted.internet.protocol.Factory.html"><code>Factory</code></a> --+
|
<a href="twisted.internet.protocol.ServerFactory.html"><code>ServerFactory</code></a> --+
|
<a href="twisted.protocols.http.HTTPFactory.html"><code>HTTPFactory</code></a> --+
|
<b>Site</b>
</pre><br />
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>resource</span>,
<span class=summary-sig-arg>logPath</span>,
<span class=summary-sig-arg>timeout</span>)</span></code>
<br />
Initialize.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#_mkuid" class="summary-sig-name"><code>_mkuid</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
(internal) Generate an opaque, unique ID for a user's session.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#_openLogFile" class="summary-sig-name"><code>_openLogFile</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
<br />
Override in subclasses, e.g.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#buildProtocol" class="summary-sig-name"><code>buildProtocol</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>addr</span>)</span></code>
<br />
Generate a channel attached to this site.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#getChildWithDefault" class="summary-sig-name"><code>getChildWithDefault</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>pathEl</span>,
<span class=summary-sig-arg>request</span>)</span></code>
<br />
Emulate a resource's getChild method.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#getResourceFor" class="summary-sig-name"><code>getResourceFor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>)</span></code>
<br />
Get a resource for a request.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#getSession" class="summary-sig-name"><code>getSession</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Get a previously generated session, by its unique ID.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#makeSession" class="summary-sig-name"><code>makeSession</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Generate a new Session instance, and store it for future
reference.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.server.Site.html#render" class="summary-sig-name"><code>render</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>)</span></code>
<br />
Redirect because a Site is always a directory.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from HTTPFactory</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.http.HTTPFactory.html#log" class="summary-sig-name"><code>log</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>)</span></code>
<br />
Log a request's result to the logfile, by default in combined log
format.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.http.HTTPFactory.html#startFactory" class="summary-sig-name"><code>startFactory</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
This will be called before I begin listening on a Port or
Connector.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.http.HTTPFactory.html#stopFactory" class="summary-sig-name"><code>stopFactory</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
This will be called before I stop listening on all
Ports/Connectors.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Factory</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Factory.html#doStart" class="summary-sig-name"><code>doStart</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Make sure startFactory is called.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Factory.html#doStop" class="summary-sig-name"><code>doStop</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Make sure stopFactory is called.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.web.server.Site.html#counter"><code>counter</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.web.server.Site.html#displayTracebacks"><code>displayTracebacks</code></a></b> = <span title="1">1 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.web.server.Site.html#isLeaf"><code>isLeaf</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>class</code></font></td>
<td><a name="requestFactory"></a><b><code>requestFactory</code></b> = <a href="twisted.web.server.Request.html"><code>twisted.web.server.Request</code></a></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from HTTPFactory</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.http.HTTPFactory.html#logPath"><code>logPath</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.protocols.http.HTTPFactory.html#timeOut"><code>timeOut</code></a></b> = <span title="43200">43200 </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Factory</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.internet.protocol.Factory.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.internet.interfaces.IProtocolFactory at 0x827f7bc>,)"><code>(<class twisted.internet.interfaces.IPr<span class="variable-ellipsis">...</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="twisted.internet.protocol.Factory.html#noisy"><code>noisy</code></a></b> = <span title="'sure, why not'"><code><span class="variable-quote">'</span>sure, why not<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.protocol.Factory.html#numPorts"><code>numPorts</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.internet.protocol.Factory.html#protocol"><code>protocol</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>resource</span>,
<span class=sig-arg>logPath</span>=<span class=sig-default>None</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>43200</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Initialize.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.http.HTTPFactory.html#__init__"><code>twisted.protocols.http.HTTPFactory.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_mkuid"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_mkuid</span>(<span class=sig-arg>self</span>)</span>
</h3>
(internal) Generate an opaque, unique ID for a user's session.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_openLogFile"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_openLogFile</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>path</span>)</span>
</h3>
Override in subclasses, e.g. to use twisted.python.logfile.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.http.HTTPFactory.html#_openLogFile"><code>twisted.protocols.http.HTTPFactory._openLogFile</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="buildProtocol"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">buildProtocol</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>addr</span>)</span>
</h3>
Generate a channel attached to this site.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.http.HTTPFactory.html#buildProtocol"><code>twisted.protocols.http.HTTPFactory.buildProtocol</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getChildWithDefault"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getChildWithDefault</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>pathEl</span>,
<span class=sig-arg>request</span>)</span>
</h3>
Emulate a resource's getChild method.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getResourceFor"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getResourceFor</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>request</span>)</span>
</h3>
<p>Get a resource for a request.</p>
This iterates through the resource heirarchy, calling
getChildWithDefault on each resource it finds for a path element,
stopping when it hits an element where isLeaf is true.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getSession"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSession</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
Get a previously generated session, by its unique ID. This raises a
KeyError if the session is not found.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="makeSession"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">makeSession</span>(<span class=sig-arg>self</span>)</span>
</h3>
Generate a new Session instance, and store it for future
reference.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="render"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">render</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>request</span>)</span>
</h3>
Redirect because a Site is always a directory.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="counter"></a>
<h3>counter</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="displayTracebacks"></a>
<h3>displayTracebacks</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="1"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
1 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="isLeaf"></a>
<h3>isLeaf</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </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="twisted.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" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:02 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>