t.w.h.HTTPChannel(basic.LineReceiver, policies.TimeoutMixin) : class documentation

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

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

A receiver for HTTP requests.
Method __init__ Undocumented
Method connectionMade Called when a connection is made.
Method lineReceived Override this for when each line is received.
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 an instance of _ChunkedTransferDecoder if the request body uses the chunked Transfer-Encoding.
Method _finishRequestBody Undocumented

Inherited from LineReceiver:

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 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

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
_transferDecoder =
None or an instance of _ChunkedTransferDecoder if the request body uses the chunked Transfer-Encoding.
def __init__(self): (source)
Undocumented
def connectionMade(self): (source)
overrides twisted.internet.protocol.BaseProtocol.connectionMade
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)
overrides twisted.protocols.basic.LineReceiver.lineReceived
Override this for when each line is received.
ParameterslineThe line which was received with the delimiter removed. (type: bytes)
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)
overrides twisted.protocols.basic.LineReceiver.rawDataReceived
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)
overrides twisted.protocols.policies.TimeoutMixin.timeoutConnection
Called when the connection times out.

Override to define behavior other than dropping the connection.

def connectionLost(self, reason): (source)
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 2014-05-12 18:27:00.