Known subclasses: twisted.web.proxy.Proxy, twisted.web.proxy.ReverseProxy

A receiver for HTTP requests.

Instance Variable MAX_LENGTH Maximum length for initial request line and each line from the header.
Instance Variable maxHeaders Maximum number of headers allowed per request. (type: int)
Instance Variable totalHeadersSize Maximum bytes for request line plus all headers from the request. (type: int)
Method __init__ Undocumented
Method connectionMade Called when a connection is made.
Method lineReceived Called for each line from request until the end of headers when it enters binary mode.
Method headerReceived Do pre-processing (for content-length) and store this header away. Enforce the per-request header limit.
Method allContentReceived Undocumented
Method rawDataReceived Override this for when raw data is received.
Method allHeadersReceived Undocumented
Method checkPersistence Check if the channel should close or not.
Method requestDone Called by first request in queue when it is done.
Method timeoutConnection Called when the connection times out.
Method connectionLost Called when the connection is shut down.
Instance Variable _transferDecoder None or a decoder instance if the request body uses the chunked Transfer-Encoding. (type: _ChunkedTransferDecoder)
Instance Variable _receivedHeaderSize Bytes received so far for the header. (type: int)
Method _finishRequestBody Undocumented

Inherited from TimeoutMixin:

Class Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method __timedOut Undocumented

Inherited from TimeoutMixin:

Class Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method __timedOut Undocumented

Inherited from TimeoutMixin:

Class Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method __timedOut Undocumented

Inherited from TimeoutMixin:

Class Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method __timedOut Undocumented

Inherited from TimeoutMixin:

Class Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method __timedOut Undocumented
MAX_LENGTH =
Maximum length for initial request line and each line from the header.
_transferDecoder =
None or a decoder instance if the request body uses the chunked Transfer-Encoding. (type: _ChunkedTransferDecoder)
maxHeaders =
Maximum number of headers allowed per request. (type: int)
totalHeadersSize =
Maximum bytes for request line plus all headers from the request. (type: int)
_receivedHeaderSize =
Bytes received so far for the header. (type: int)
def __init__(self): (source)
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 lineReceived(self, line): (source)

Called for each line from request until the end of headers when it enters binary mode.

def _finishRequestBody(self, data): (source)
Undocumented
def headerReceived(self, line): (source)

Do pre-processing (for content-length) and store this header away. Enforce the per-request header limit.

ParameterslineA line from the header section of a request, excluding the line delimiter. (type: bytes)
def allContentReceived(self): (source)
Undocumented
def rawDataReceived(self, data): (source)

Override this for when raw data is received.

def allHeadersReceived(self): (source)
Undocumented
def checkPersistence(self, request, version): (source)

Check if the channel should close or not.

ParametersrequestThe request most recently received over this channel against which checks will be made to determine if this connection can remain open after a matching response is returned.
versionThe version of the request. (type: bytes)
ReturnsA flag which, if True, indicates that this connection may remain open to receive another request; if False, the connection must be closed in order to indicate the completion of the response to request. (type: bool)
def requestDone(self, request): (source)

Called by first request in queue when it is done.

def timeoutConnection(self): (source)

Called when the connection times out.

Override to define behavior other than dropping the connection.

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.

API Documentation for Twisted, generated by pydoctor at 2015-11-29 11:40:45.