twisted.web.client.HTTPPageGetter(http.HTTPClient)
class documentationtwisted.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 | Handle the HTTP status line. |
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 | When the connection used to issue the HTTP request is closed, notify the factory if we have not already, so it can produce a result. |
Method | handleResponse | Undocumented |
Method | timeout | Undocumented |
Instance Variable | _completelyDone | A boolean indicating whether any further requests are necessary after this
one completes in order to provide a result to
self.factory.deferred . If it is False , then a
redirect is going to be followed. Otherwise, this protocol's connection is
the last one before firing the result Deferred. This is used to make sure
the result Deferred is only fired after the connection is cleaned up. |
Inherited from HTTPClient:
Instance Variable | length | The length of the request body in bytes. (type: int ) |
Instance Variable | firstLine | Are we waiting for the first header line? (type: bool ) |
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. |
Instance Variable | __buffer | The buffer that stores the response to the HTTP request. (type: A StringIO object.) |
Instance Variable | _header | Part or all of an HTTP request header. (type: bytes ) |
Inherited from LineReceiver (via HTTPClient):
Class Variable | delimiter | The line-ending delimiter to use. By default this is b'\r\n' . |
Class Variable | MAX_LENGTH | The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384. |
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 Protocol (via HTTPClient, LineReceiver):
Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
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 |
self.factory.deferred
. If it is False
, then a
redirect is going to be followed. Otherwise, this protocol's connection is
the last one before firing the result Deferred. This is used to make sure
the result Deferred is only fired after the connection is cleaned up.
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.
Called every time a header is received. Stores the header information as
key-value pairs in the headers
attribute.
Parameters | key | An HTTP header field name. (type: str ) |
value | An HTTP header field value. (type: str ) |
When the connection used to issue the HTTP request is closed, notify the factory if we have not already, so it can produce a result.