<?xml version="1.0" encoding="ascii"?>
<!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.http.HTTPChannel</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
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%">
<span class="breadcrumbs">
twisted ::
web ::
http ::
HTTPChannel ::
Class HTTPChannel
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class HTTPChannel</h1><p class="nomargin-top"></p>
<pre class="base-tree">
internet.protocol.BaseProtocol --+
|
internet.protocol.Protocol --+
|
protocols.basic._PauseableMixin --+
|
protocols.basic.LineReceiver --+
|
protocols.policies.TimeoutMixin --+
|
<strong class="uidshort">HTTPChannel</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="flumotion.twisted.rtsp.RTSPChannel-class.html">flumotion.twisted.rtsp.RTSPChannel</a></li> </ul>
</dd></dl>
<hr />
<p>A receiver for HTTP requests.</p>
<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Nested Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-NestedClasses"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="twisted.web.http.Request-class.html" class="summary-name">requestFactory</a><br />
A HTTP request.
</td>
</tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_finishRequestBody"></a><span class="summary-sig-name">_finishRequestBody</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">data</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="allContentReceived"></a><span class="summary-sig-name">allContentReceived</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="allHeadersReceived"></a><span class="summary-sig-name">allHeadersReceived</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>bool</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="twisted.web.http.HTTPChannel-class.html#checkPersistence" class="summary-sig-name">checkPersistence</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">request</span>,
<span class="summary-sig-arg">version</span>)</span><br />
Check if the channel should close or not.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="twisted.web.http.HTTPChannel-class.html#connectionLost" class="summary-sig-name">connectionLost</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">reason</span>)</span><br />
Called when the connection is shut down.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="twisted.web.http.HTTPChannel-class.html#connectionMade" class="summary-sig-name">connectionMade</a>(<span class="summary-sig-arg">self</span>)</span><br />
Called when a connection is made.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="twisted.web.http.HTTPChannel-class.html#headerReceived" class="summary-sig-name">headerReceived</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">line</span>)</span><br />
Do pre-processing (for content-length) and store this header away.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="twisted.web.http.HTTPChannel-class.html#lineReceived" class="summary-sig-name">lineReceived</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">line</span>)</span><br />
Override this for when each line is received.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="twisted.web.http.HTTPChannel-class.html#rawDataReceived" class="summary-sig-name">rawDataReceived</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">data</span>)</span><br />
Override this for when raw data is received.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="requestDone"></a><span class="summary-sig-name">requestDone</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">request</span>)</span><br />
Called by first request in queue when it is done.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="twisted.web.http.HTTPChannel-class.html#timeoutConnection" class="summary-sig-name">timeoutConnection</a>(<span class="summary-sig-arg">self</span>)</span><br />
Called when the connection times out.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>protocols.basic.LineReceiver</code></b>:
<code>clearLineBuffer</code>,
<code>dataReceived</code>,
<code>lineLengthExceeded</code>,
<code>sendLine</code>,
<code>setLineMode</code>,
<code>setRawMode</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>internet.protocol.Protocol</code></b>:
<code>__provides__</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>internet.protocol.BaseProtocol</code></b>:
<code>__providedBy__</code>,
<code>makeConnection</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>protocols.basic._PauseableMixin</code></b>:
<code>pauseProducing</code>,
<code>resumeProducing</code>,
<code>stopProducing</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>protocols.policies.TimeoutMixin</code></b>:
<code>callLater</code>,
<code>resetTimeout</code>,
<code>setTimeout</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__content"></a><span class="summary-name">__content</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__first_line"></a><span class="summary-name">__first_line</span> = <code title="1">1</code><br />
hash(x)
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__header"></a><span class="summary-name">__header</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_receivedHeaderCount"></a><span class="summary-name">_receivedHeaderCount</span> = <code title="0">0</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_savedTimeOut"></a><span class="summary-name">_savedTimeOut</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="length"></a><span class="summary-name">length</span> = <code title="0">0</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="maxHeaders"></a><span class="summary-name">maxHeaders</span> = <code title="500">500</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="persistent"></a><span class="summary-name">persistent</span> = <code title="1">1</code><br />
hash(x)
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>protocols.basic.LineReceiver</code></b>:
<code>MAX_LENGTH</code>,
<code>delimiter</code>,
<code>line_mode</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>internet.protocol.Protocol</code></b>:
<code>__implemented__</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>internet.protocol.BaseProtocol</code></b>:
<code>connected</code>,
<code>transport</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>protocols.basic._PauseableMixin</code></b>:
<code>paused</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>protocols.policies.TimeoutMixin</code></b>:
<code>timeOut</code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_transferDecoder"></a><span class="summary-name">_transferDecoder</span><br />
<code>None</code> or an instance of <code
class="link">_ChunkedTransferEncoding</code> if the request body uses
the <i>chunked</i> Transfer-Encoding.
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="checkPersistence"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">checkPersistence</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">request</span>,
<span class="sig-arg">version</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Check if the channel should close or not.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>request</code></strong> - The request most recently received over this channel against
which checks will be made to determine if this connection can
remain open after a matching response is returned.</li>
<li><strong class="pname"><code>version</code></strong> (<code>str</code>) - The version of the request.</li>
</ul></dd>
<dt>Returns: <code>bool</code></dt>
<dd>A flag which, if <code>True</code>, indicates that this
connection may remain open to receive another request; if
<code>False</code>, the connection must be closed in order to
indicate the completion of the response to <code>request</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="connectionLost"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">connectionLost</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">reason</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Called when the connection is shut down.</p>
<p>Clear any circular references here, and any external references to
this Protocol. The connection has been closed.</p>
<dl class="fields">
<dt>Overrides:
internet.protocol.Protocol.connectionLost
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="connectionMade"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">connectionMade</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Called when a connection is made.</p>
<p>This may be considered the initializer of the protocol, because it is
called when the connection is completed. For clients, this is called
once the connection to the server has been established; for servers, this
is called after an accept() call stops blocking and a socket has been
received. If you need to send any greeting or initial message, do it
here.</p>
<dl class="fields">
<dt>Overrides:
internet.protocol.BaseProtocol.connectionMade
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="headerReceived"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">headerReceived</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">line</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Do pre-processing (for content-length) and store this header away.
Enforce the per-request header limit.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>line</code></strong> (<code>str</code>) - A line from the header section of a request, excluding the line
delimiter.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="lineReceived"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">lineReceived</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">line</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Override this for when each line is received.</p>
<dl class="fields">
<dt>Overrides:
protocols.basic.LineReceiver.lineReceived
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="rawDataReceived"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">rawDataReceived</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">data</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Override this for when raw data is received.</p>
<dl class="fields">
<dt>Overrides:
protocols.basic.LineReceiver.rawDataReceived
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="timeoutConnection"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">timeoutConnection</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Called when the connection times out. Override to define behavior
other than dropping the connection.</p>
<dl class="fields">
<dt>Overrides:
protocols.policies.TimeoutMixin.timeoutConnection
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
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" class="footer">
Generated by Epydoc 3.0.1 on Wed Aug 11 21:33:18 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
