Part of twisted.web.http View Source View In Hierarchy
Known subclasses: twisted.protocols.shoutcast.ShoutcastClient, twisted.web.client.HTTPPageGetter, twisted.web.google.GoogleChecker, twisted.web.proxy.ProxyClient, twisted.web.xmlrpc.QueryProtocol, twisted.words.protocols.msn.PassportLogin, twisted.words.protocols.msn.PassportNexus
Notes: You probably want to send a 'Host' header with the name of the site you're connecting to, in order to not break name based virtual hosting.
| 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 | connectionLost | Called when the connection is shut down. |
| Method | handleResponseEnd | The response has been completely received. |
| Method | handleResponsePart | Undocumented |
| Method | connectionMade | Called when a connection is made. |
| Method | handleStatus | Called when the status-line is received. |
| Method | handleHeader | Called every time a header is received. |
| Method | handleEndHeaders | Called when all headers have been received. |
| 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: str) |
Inherited from LineReceiver:
| Class Variable | delimiter | The line-ending delimiter to use. By default this is '\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 LineReceiver):
| Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via LineReceiver, Protocol):
| Method | makeConnection | Make a connection to a transport and a server. |
Inherited from _PauseableMixin (via LineReceiver):
| Method | pauseProducing | Undocumented |
| Method | resumeProducing | Undocumented |
| Method | stopProducing | Undocumented |
| Parameters | header | a complete HTTP request header of the form 'field-name: value'. (type: str) |
| Parameters | line | Part of an HTTP request header. Request bodies are parsed in rawDataReceived. (type: str) |
Clear any circular references here, and any external references to this Protocol. The connection has been closed.
This callback may be invoked more than once per request.
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.
| Parameters | version | e.g. 'HTTP/1.0' |
| status | e.g. '200' (type: str) | |
| message | e.g. 'OK' |