t.w.c.HTTPPageGetter(http.HTTPClient) : class documentation

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

Known subclasses: twisted.web.client.HTTPPageDownloader

Gets a resource via HTTP, then quits.

Typically used with HTTPClientFactory. Note that this class does not, by itself, do anything with the response. If you want to download a resource into a file, use HTTPPageDownloader instead.
Method connectionMade Called when a connection is made.
Method handleHeader Called every time a header is received. Stores the header information as key-value pairs in the headers attribute.
Method handleStatus Called when the status-line is received.
Method handleEndHeaders Called when all headers have been received.
Method handleStatus_200 Undocumented
Method handleStatusDefault Undocumented
Method handleStatus_301 Undocumented
Method handleStatus_302 Undocumented
Method handleStatus_303 Undocumented
Method connectionLost Called when the connection is shut down.
Method handleResponse Undocumented
Method timeout Undocumented

Inherited from HTTPClient:

Method sendCommand Undocumented
Method sendHeader Undocumented
Method endHeaders Undocumented
Method extractHeader Given a complete HTTP header, extract the field name and value and process the header.
Method lineReceived Parse the status line and headers for an HTTP request.
Method handleResponseEnd The response has been completely received.
Method handleResponsePart Undocumented
Method rawDataReceived Override this for when raw data is received.

Inherited from LineReceiver (via HTTPClient):

Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method sendLine Sends a line to the other end of the connection.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

Inherited from BaseProtocol (via HTTPClient, LineReceiver, Protocol):

Method makeConnection Make a connection to a transport and a server.

Inherited from _PauseableMixin (via HTTPClient, LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
def connectionMade(self): (source)

Called when a connection is made.

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.
def handleHeader(self, key, value): (source)
Called every time a header is received. Stores the header information as key-value pairs in the headers attribute.
ParameterskeyAn HTTP header field name. (type: str )
valueAn HTTP header field value. (type: str )
def handleStatus(self, version, status, message): (source)
Called when the status-line is received.
Parametersversione.g. 'HTTP/1.0'
statuse.g. '200' (type: str )
messagee.g. 'OK'
def handleEndHeaders(self): (source)
Called when all headers have been received.
def handleStatus_200(self): (source)
def handleStatusDefault(self): (source)
def handleStatus_301(self): (source)
def handleStatus_302(self): (source)
def handleStatus_303(self): (source)
def connectionLost(self, reason): (source)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parametersreason (type: twisted.python.failure.Failure )
def handleResponse(self, response): (source)
def timeout(self): (source)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.