t.w.c.HTTPClientFactory(protocol.ClientFactory) : class documentation

Part of twisted.web.client View Source View In Hierarchy

Known subclasses: twisted.web.client.HTTPDownloader

Download a given URL.
Instance VariablesdeferredA Deferred that will fire when the content has been retrieved. Once this is fired, the ivars `status', `version', and `message' will be set. (type: Deferred )
statusThe status of the response. (type: str )
versionThe version of the response. (type: str )
messageThe text message returned with the status. (type: str )
response_headersThe headers that were specified in the response from the server. (type: dict )
methodThe HTTP method to use in the request. This should be one of OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, or CONNECT (case matters). Other values may be specified if the server being contacted supports them. (type: str )
redirectLimitThe maximum number of HTTP redirects that can occur before it is assumed that the redirection is endless. (type: int )
afterFoundGetDeviate from the HTTP 1.1 RFC by handling redirects the same way as most web browsers; if the request method is POST and a 302 status is encountered, the redirect is followed with a GET method (type: bool )
_redirectCountThe current number of HTTP redirects encountered. (type: int )
Method __init__ Undocumented
Method __repr__ Undocumented
Method setURL Undocumented
Method buildProtocol Create an instance of a subclass of Protocol.
Method gotHeaders Undocumented
Method gotStatus Undocumented
Method page Undocumented
Method noPage Undocumented
Method clientConnectionFailed Called when a connection has failed to connect.
Method _cancelTimeout Undocumented

Inherited from ClientFactory:

Method startedConnecting Called when a connection has been started.
Method clientConnectionLost Called when an established connection is lost.

Inherited from Factory (via ClientFactory):

Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
Method startFactory This will be called before I begin listening on a Port or Connector.
Method stopFactory This will be called before I stop listening on all Ports/Connectors.
def __init__(self, url, method='GET', postdata=None, headers=None, agent='Twisted PageGetter', timeout=0, cookies=None, followRedirect=True, redirectLimit=20, afterFoundGet=False): (source)
def __repr__(self): (source)
def setURL(self, url): (source)
def buildProtocol(self, addr): (source)

Create an instance of a subclass of Protocol.

The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.

Override this method to alter how Protocol instances get created.
Parametersaddran object implementing twisted.internet.interfaces.IAddress
def _cancelTimeout(self, result, timeoutCall): (source)
def gotHeaders(self, headers): (source)
def gotStatus(self, version, status, message): (source)
def page(self, page): (source)
def noPage(self, reason): (source)
def clientConnectionFailed(self, _, reason): (source)

Called when a connection has failed to connect.

It may be useful to call connector.connect() - this will reconnect.
Parametersreason (type: twisted.python.failure.Failure )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.