t.w._.HTTPClientParser(HTTPParser) : class documentation

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

An HTTP parser which only handles HTTP responses.
Instance Variable request The request with which the expected response is associated. (type: Request)
Instance Variable NO_BODY_CODES A set of response codes which MUST NOT have a body.
Instance Variable finisher A callable to invoke when this response is fully parsed.
Method __init__ Undocumented
Method dataReceived Override so that we know if any response has been received.
Method parseVersion Parse version strings of the form Protocol '/' Major '.' Minor. E.g. 'HTTP/1.1'. Returns (protocol, major, minor). Will raise ValueError on bad syntax.
Method statusReceived Parse the status line into its components and create a response object to keep track of this response's state.
Method isConnectionControlHeader Content-Length in the response to a HEAD request is an entity header, not a connection control header.
Method allHeadersReceived Figure out how long the response body is going to be by examining headers and stuff.
Method connectionLost Called when the connection is shut down.
Instance Variable _responseDeferred A Deferred which will be called back with the response when all headers in the response have been received. Thereafter, None.
Instance Variable _everReceivedData True if any bytes have been received.
Method _finished Called to indicate that an entire response has been received. No more bytes will be interpreted by this HTTPClientParser. Extra bytes are passed up and the state of this HTTPClientParser is set to DONE.

Inherited from HTTPParser:

Instance Variable headers All of the non-connection control message headers yet received.
Instance Variable state State indicator for the response parsing state machine. One of STATUS, HEADER, BODY, DONE.
Method connectionMade Called when a connection is made.
Method switchToBodyMode Switch to body parsing mode - interpret any more bytes delivered as part of the message body and deliver them to the given decoder.
Method lineReceived Handle one line from a response.
Method rawDataReceived Pass data from the message body to the body decoder object.
Method headerReceived Store the given header in self.headers.
Instance Variable _partialHeader None or a list of the lines of a multiline header while that header is being received.

Inherited from LineReceiver (via HTTPParser):

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 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 HTTPParser, LineReceiver):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.

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

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

Inherited from _PauseableMixin (via HTTPParser, LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
request =
The request with which the expected response is associated. (type: Request)
NO_BODY_CODES =
A set of response codes which MUST NOT have a body.
finisher =
A callable to invoke when this response is fully parsed.
_responseDeferred =
A Deferred which will be called back with the response when all headers in the response have been received. Thereafter, None.
_everReceivedData =
True if any bytes have been received.
def __init__(self, request, finisher): (source)
Undocumented
def dataReceived(self, data): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.protocols.basic.LineReceiver.dataReceived
Override so that we know if any response has been received.
def parseVersion(self, strversion): (source)
Parse version strings of the form Protocol '/' Major '.' Minor. E.g. 'HTTP/1.1'. Returns (protocol, major, minor). Will raise ValueError on bad syntax.
def statusReceived(self, status): (source)
overrides twisted.web._newclient.HTTPParser.statusReceived
Parse the status line into its components and create a response object to keep track of this response's state.
def _finished(self, rest): (source)
Called to indicate that an entire response has been received. No more bytes will be interpreted by this HTTPClientParser. Extra bytes are passed up and the state of this HTTPClientParser is set to DONE.
ParametersrestA str giving any extra bytes delivered to this HTTPClientParser which are not part of the response being parsed.
def isConnectionControlHeader(self, name): (source)
overrides twisted.web._newclient.HTTPParser.isConnectionControlHeader
Content-Length in the response to a HEAD request is an entity header, not a connection control header.
def allHeadersReceived(self): (source)
overrides twisted.web._newclient.HTTPParser.allHeadersReceived
Figure out how long the response body is going to be by examining headers and stuff.
def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost
Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.