twisted.web.client.HTTPClientFactory-class.html
fb50ed06a412master

twisted.web.client.HTTPClientFactory-class.html
View Options

			<?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.client.HTTPClientFactory</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="Pyblio-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" align="right" width="100%">
			<table border="0" cellpadding="0" cellspacing="0">
			<tr><th class="navbar" align="center">
			<p class="nomargin">
			pybliographer 1.3.3
			</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">
			Package twisted ::
			Package web ::
			Module client ::
			Class HTTPClientFactory
			</b></font></br>
			</td>
			<td><table cellpadding="0" cellspacing="0">
			<tr><td align="right"><font size="-2">[show private \| <a href="../public/twisted.web.client.HTTPClientFactory-class.html">hide private</a>]</font></td></tr>
			<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> \| <a href="twisted.web.client.HTTPClientFactory-class.html" target="_top">no frames</a>]</font></td></tr>
			</table></td>
			</tr></table>

			<!-- =========== START OF CLASS DESCRIPTION =========== -->
			<h2 class="class">Class HTTPClientFactory</h2>

			<pre class="base-tree">
			<a href="twisted.internet.protocol.Factory-class.html"><code>Factory</code></a> --+
			\|
			<a href="twisted.internet.protocol.ClientFactory-class.html"><code>ClientFactory</code></a> --+
			\|
			<b>HTTPClientFactory</b>
			</pre><br />

			<dl><dt><b>Known Subclasses:</b></dt>
			<dd>
			<a href="Pyblio.External.HTTP.HTTPRetrieve-class.html"><code>HTTPRetrieve</code></a></dd></dl>

			<hr/>

			Download a given URL.
			<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>url</span>,
			<span class=summary-sig-arg>method</span>,
			<span class=summary-sig-arg>postdata</span>,
			<span class=summary-sig-arg>headers</span>,
			<span class=summary-sig-arg>agent</span>,
			<span class=summary-sig-arg>timeout</span>,
			<span class=summary-sig-arg>cookies</span>,
			<span class=summary-sig-arg>followRedirect</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</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.client.HTTPClientFactory-class.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 />
			Create an instance of a subclass of Protocol.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><a name="clientConnectionFailed"></a><span class="summary-sig"><span class="summary-sig-name">clientConnectionFailed</span>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>_</span>,
			<span class=summary-sig-arg>reason</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><a name="gotHeaders"></a><span class="summary-sig"><span class="summary-sig-name">gotHeaders</span>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>headers</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><a name="gotStatus"></a><span class="summary-sig"><span class="summary-sig-name">gotStatus</span>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>version</span>,
			<span class=summary-sig-arg>status</span>,
			<span class=summary-sig-arg>message</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><a name="noPage"></a><span class="summary-sig"><span class="summary-sig-name">noPage</span>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>reason</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><a name="page"></a><span class="summary-sig"><span class="summary-sig-name">page</span>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>page</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><a name="setURL"></a><span class="summary-sig"><span class="summary-sig-name">setURL</span>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>url</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><a name="_cancelTimeout"></a><span class="summary-sig"><span class="summary-sig-name">_cancelTimeout</span>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>result</span>,
			<span class=summary-sig-arg>timeoutCall</span>)</span></code>
			</td></tr>
			<tr bgcolor="#e8f0f8" class="group">
			<th colspan="2">    Inherited from ClientFactory</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.ClientFactory-class.html#clientConnectionLost" class="summary-sig-name"><code>clientConnectionLost</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>connector</span>,
			<span class=summary-sig-arg>reason</span>)</span></code>
			<br />
			Called when an established connection is lost.</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.ClientFactory-class.html#startedConnecting" class="summary-sig-name"><code>startedConnecting</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>connector</span>)</span></code>
			<br />
			Called when a connection has been started.</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-class.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-class.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>
			<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-class.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.internet.protocol.Factory-class.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>
			</table><br />


			<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
			<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
			<tr bgcolor="#70b0f0" class="summary">
			<th colspan="2">Instance Variable Summary</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1">Deferred</font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#deferred"><code>deferred</code></a></b>: A Deferred that will fire when the content has been retrieved.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#message"><code>message</code></a></b>: The text message returned with the status.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1">dict</font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#response_headers"><code>response_headers</code></a></b>: The headers that were specified in the response from the server.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#status"><code>status</code></a></b>: The status of the response.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#version"><code>version</code></a></b>: The version of the response.</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>str</code></font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#host"><code>host</code></a></b> = <span title="''"><code><span class="variable-quote">'</span><span class="variable-quote">'</span> </code>
			</span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#path"><code>path</code></a></b> = <span title="None">None                                                                  </span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#port"><code>port</code></a></b> = <span title="None">None                                                                  </span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>classobj</code></font></td>
			<td><a name="protocol"></a><b><code>protocol</code></b> = <a href="twisted.web.client.HTTPPageGetter-class.html"><code>twisted.web.client.HTTPPageGetter</code></a></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#scheme"><code>scheme</code></a></b> = <span title="None">None                                                                  </span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
			<td><b><a href="twisted.web.client.HTTPClientFactory-class.html#url"><code>url</code></a></b> = <span title="None">None                                                                  </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>Implements</code></font></td>
			<td><b><a href="twisted.internet.protocol.Factory-class.html#__implemented__"><code>__implemented__</code></a></b> = <span title="<implementedBy twisted.internet.protocol.Factory>"><code><implementedBy twisted.internet.protoc<span class="variable-ellipsis">...</span></code>
			</span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>ClassProvides</code></font></td>
			<td><b><a href="twisted.internet.protocol.Factory-class.html#__providedBy__"><code>__providedBy__</code></a></b> = <span title="<zope.interface.declarations.ClassProvides object at 0xa57eb20c>"><code><zope.interface.declarations.ClassProvi<span class="variable-ellipsis">...</span></code>
			</span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>ClassProvides</code></font></td>
			<td><b><a href="twisted.internet.protocol.Factory-class.html#__provides__"><code>__provides__</code></a></b> = <span title="<zope.interface.declarations.ClassProvides object at 0xa57eb20c>"><code><zope.interface.declarations.ClassProvide<span class="variable-ellipsis">...</span></code>
			</span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td>
			<td><b><a href="twisted.internet.protocol.Factory-class.html#noisy"><code>noisy</code></a></b> = <span title="True"><code>True </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-class.html#numPorts"><code>numPorts</code></a></b> = <span title="0">0                                                                     </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="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>
			<p>Create an instance of a subclass of Protocol.</p>
			<p>The returned instance will handle input on an incoming server
			connection, and an attribute "factory" pointing to the
			creating factory.</p>
			Override this method to alter how Protocol instances get
			created.
			<dl><dt></dt><dd>
			<dl><dt><b>Parameters:</b></dt>
			<dd><code><b>addr</b></code> -
			an object implementing
			<code>twisted.internet.interfaces.IAddress</code>
			</dd>
			</dl>
			<dl><dt><b>Overrides:</b></dt>
			<dd><a href="twisted.internet.protocol.Factory-class.html#buildProtocol"><code>twisted.internet.protocol.Factory.buildProtocol</code></a> <i>(inherited documentation)</i>
			</dd>
			</dl>
			</dd></dl>
			</td></tr></table>
			<br />


			<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
			<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
			<tr bgcolor="#70b0f0" class="details">
			<th colspan="2">Instance Variable Details</th></tr>
			</table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="deferred"></a>
			<h3>deferred</h3>
			A Deferred that will fire when the content has been retrieved. Once
			this is fired, the ivars `status', `version', and `message' will be
			set.
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			Deferred

			</dd>
			</dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="message"></a>
			<h3>message</h3>
			The text message returned with the status.
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			str

			</dd>
			</dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="response_headers"></a>
			<h3>response_headers</h3>
			The headers that were specified in the response from the server.
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			dict

			</dd>
			</dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="status"></a>
			<h3>status</h3>
			The status of the response.
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			str

			</dd>
			</dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="version"></a>
			<h3>version</h3>
			The version of the response.
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			str

			</dd>
			</dl>
			</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="host"></a>
			<h3>host</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>str</code>

			</dd>
			<span title="''"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			<span class="variable-quote">'</span><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="path"></a>
			<h3>path</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>NoneType</code>

			</dd>
			<span title="None"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			None                                                                  </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="port"></a>
			<h3>port</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>NoneType</code>

			</dd>
			<span title="None"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			None                                                                  </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="scheme"></a>
			<h3>scheme</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>NoneType</code>

			</dd>
			<span title="None"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			None                                                                  </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="url"></a>
			<h3>url</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>NoneType</code>

			</dd>
			<span title="None"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			None                                                                  </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="Pyblio-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" align="right" width="100%">
			<table border="0" cellpadding="0" cellspacing="0">
			<tr><th class="navbar" align="center">
			<p class="nomargin">
			pybliographer 1.3.3
			</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.1 on Sun Sep 24 23:52:43 2006</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>

R3596/doc/reference/private/twisted.web.client.HTTPClientFactory-class.htmlfb50ed06a412master

twisted.web.client.HTTPClientFactory-class.htmlView Options

R3596/doc/reference/private/twisted.web.client.HTTPClientFactory-class.html
fb50ed06a412master

twisted.web.client.HTTPClientFactory-class.html
View Options