class HTTPChannel(basic.LineReceiver, policies.TimeoutMixin): (source)
Known subclasses: twisted.web.proxy.Proxy, twisted.web.proxy.ReverseProxy
Implements interfaces: twisted.internet.interfaces.IConsumer, twisted.internet.interfaces.IPushProducer, twisted.internet.interfaces.ITransport
A receiver for HTTP requests.
The HTTPChannel provides interfaces.ITransport and interfaces.IConsumer to the Request objects it creates. It also implements interfaces.IPushProducer to self.transport, allowing the transport to pause it.
| Method | __init__ |
Undocumented |
| Method | all |
Undocumented |
| Method | all |
Undocumented |
| Method | check |
Check if the channel should close or not. |
| Method | connection |
Called when the connection is shut down. |
| Method | connection |
Called when a connection is made. |
| Method | data |
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
| Method | force |
Called if abortTimeout seconds have passed since the timeout fired, and the connection still hasn't gone away. This can really only happen on extremely bad connections or when clients are maliciously attempting to keep connections open. |
| Method | get |
Get the local address of this connection. |
| Method | get |
Get the remote address of this connection. |
| Method | header |
Do pre-processing (for Content-Length) and store this header away. Enforce the per-request header limit. |
| Method | is |
Return True if this channel is using a secure transport. |
| Method | line |
Called for each line from request until the end of headers when it enters binary mode. |
| Method | lose |
Closes the connection. Will write any data that is pending to be sent on the network, but if this response has not yet been written to the network will not write anything. |
| Method | pause |
Pause producing data. |
| Method | raw |
This is called when this HTTP/1.1 parser is in raw mode rather than line mode. |
| Method | register |
Register to receive data from a producer. |
| Method | request |
Called by first request in queue when it is done. |
| Method | resume |
Resume producing data. |
| Method | stop |
Stop producing data. |
| Method | timeout |
Called when the connection times out. |
| Method | unregister |
Stop consuming data from a producer, without disconnecting. |
| Method | write |
Called by Request objects to write response data. |
| Method | write |
Called by Request objects to write a complete set of HTTP headers to a transport. |
| Method | write |
Write a list of strings to the HTTP response. |
| Instance Variable | abort |
The number of seconds to wait after we attempt to shut the transport down cleanly to give up and forcibly terminate it. This is only used when we time a connection out, to prevent errors causing the FD to get leaked... |
| Instance Variable | length |
Undocumented |
| Instance Variable | MAX |
Maximum length for initial request line and each line from the header. |
| Instance Variable | max |
Maximum number of headers allowed per request. |
| Instance Variable | persistent |
Undocumented |
| Instance Variable | requests |
Undocumented |
| Instance Variable | total |
Maximum bytes for request line plus all headers from the request. |
| Method | _fail |
Utility to indicate failure to choose a decoder. |
| Method | _finish |
Undocumented |
| Method | _maybe |
If the provided header is content-length or transfer-encoding, choose the appropriate decoder if any. |
| Method | _respond |
This is a quick and dirty way of responding to bad requests. |
| Method | _send100 |
Sends a 100 Continue response, used to signal to clients that further processing will be performed. |
| Class Variable | __content |
Undocumented |
| Class Variable | __header |
Undocumented |
| Class Variable | _log |
Undocumented |
| Instance Variable | __first |
Undocumented |
| Instance Variable | _aborting |
The twisted.internet.base.DelayedCall that will be used to forcibly close the transport if it doesn't close cleanly. |
| Instance Variable | _command |
Undocumented |
| Instance Variable | _data |
Any data that has been received from the connection while processing an outstanding request. |
| Instance Variable | _handling |
Whether a request is currently being processed. |
| Instance Variable | _network |
Either the transport, if it provides interfaces.IPushProducer, or a null implementation of interfaces.IPushProducer. Used to attempt to prevent the transport from producing excess data when we're responding to a request. |
| Instance Variable | _optimistic |
When a resource takes a long time to answer a request (via twisted.web.server.NOT_DONE_YET, hopefully one day by a Deferred), we would like to be able to let that resource know about the underlying transport disappearing as promptly as possible, via ... |
| Instance Variable | _path |
Undocumented |
| Instance Variable | _received |
Undocumented |
| Instance Variable | _received |
Bytes received so far for the header. |
| Instance Variable | _request |
If the Request object or anything it calls registers itself as an interfaces.IProducer, it will be stored here. This is used to create a producing pipeline: pause/resume producing methods will be propagated from the ... |
| Instance Variable | _request |
A boolean that tracks whether the producer on the Request side of this channel has registered itself as a interfaces.IPushProducer or an interfaces.IPullProducer. |
| Instance Variable | _saved |
Undocumented |
| Instance Variable | _transfer |
None or a decoder instance if the request body uses the chunked Transfer-Encoding. |
| Instance Variable | _version |
Undocumented |
| Instance Variable | _waiting |
A boolean that tracks whether the transport has asked us to stop producing. This is used to keep track of what we're waiting for: if the transport has asked us to stop producing then we don't want to unpause the transport until it asks us to produce again. |
Inherited from LineReceiver:
| Method | clear |
Clear buffered data. |
| Method | line |
Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
| Method | send |
Sends a line to the other end of the connection. |
| Method | set |
Sets the line-mode of this receiver. |
| Method | set |
Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
| Class Variable | delimiter |
The line-ending delimiter to use. By default this is b'\r\n'. |
| Instance Variable | line |
Undocumented |
| Instance Variable | _buffer |
Undocumented |
| Instance Variable | _busy |
Undocumented |
Inherited from Protocol (via LineReceiver):
| Method | log |
Return a prefix matching the class name, to identify log messages related to this protocol instance. |
| Class Variable | factory |
Undocumented |
Inherited from BaseProtocol (via LineReceiver, Protocol):
| Method | make |
Make a connection to a transport and a server. |
| Instance Variable | connected |
Undocumented |
| Instance Variable | transport |
Undocumented |
Inherited from _PauseableMixin (via LineReceiver, Protocol, BaseProtocol):
| Instance Variable | paused |
Undocumented |
Inherited from TimeoutMixin (via LineReceiver, Protocol, BaseProtocol, _PauseableMixin):
| Method | call |
Wrapper around reactor.callLater for test purpose. |
| Method | reset |
Reset the timeout count down. |
| Method | set |
Change the timeout period |
| Instance Variable | time |
The number of seconds after which to timeout the connection. |
| Method | __timed |
Undocumented |
| Instance Variable | __timeout |
Undocumented |
Check if the channel should close or not.
| Parameters | |
| request | The 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. |
| version:bytes | The version of the request. |
| Returns | |
| bool | A 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. |
Called when the connection is shut down.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.
| Parameters | |
reason:twisted.python.failure.Failure | Undocumented |
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.
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Called if abortTimeout seconds have passed since the timeout fired, and the connection still hasn't gone away. This can really only happen on extremely bad connections or when clients are maliciously attempting to keep connections open.
Do pre-processing (for Content-Length) and store this header away. Enforce the per-request header limit.
| Parameters | |
| line:bytes | A line from the header section of a request, excluding the line delimiter. |
| Returns | |
bool | A flag indicating whether the header was valid. |
Return True if this channel is using a secure transport.
Normally this method returns True if this instance is using a transport that implements interfaces.ISSLTransport.
| Returns | |
| bool | True if this request is secure |
Closes the connection. Will write any data that is pending to be sent on the network, but if this response has not yet been written to the network will not write anything.
| Returns | |
None |
Pause producing data.
This will be called by the transport when the send buffers have been filled up. We want to simultaneously pause the producing Request object and also pause our transport.
The logic behind pausing the transport is specifically to avoid issues like https://twistedmatrix.com/trac/ticket/8868. In this case, our inability to send does not prevent us handling more requests, which means we increasingly queue up more responses in our send buffer without end. The easiest way to handle this is to ensure that if we are unable to send our responses, we will not read further data from the connection until the client pulls some data out. This is a bit of a blunt instrument, but it's ok.
Note that this potentially interacts with timeout handling in a positive way. Once the transport is paused the client may run into a timeout which will cause us to tear the connection down. That's a good thing!
This is called when this HTTP/1.1 parser is in raw mode rather than line mode.
It may be in raw mode for one of two reasons:
- All the headers of a request have been received and this
HTTPChannelis currently receiving its body. - The full content of a request has been received and is currently being processed asynchronously, and this
HTTPChannelis buffering the data of all subsequent requests to be parsed later.
In the second state, the data will be played back later.
| See Also | |
LineReceive.rawDataReceived | |
| Note | |
This isn't really a public API, and should be invoked only by LineReceiver's line parsing logic. If you wish to drive an HTTPChannel from a custom data source, call dataReceived on it directly. |
Register to receive data from a producer.
This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().
For IPullProducer providers, resumeProducing will be called once each time data is required.
For IPushProducer providers, pauseProducing will be called whenever the write buffer fills up and resumeProducing will only be called when it empties.
| Parameters | |
producer:IProducer provider | The IProducer that will be producing data. |
streaming:bool | True if producer provides IPushProducer, False if producer provides IPullProducer. |
| Returns | |
None | |
| Raises | |
RuntimeError | If a producer is already registered. |
Resume producing data.
This will be called by the transport when the send buffer has dropped enough to actually send more data. When this happens we can unpause any outstanding Request producers we have, and also unpause our transport.
Stop producing data.
The HTTPChannel doesn't *actually* implement this, beacuse the assumption is that it will only be called just before loseConnection is called. There's nothing sensible we can do other than call loseConnection anyway.
Called when the connection times out.
Override to define behavior other than dropping the connection.
Called by Request objects to write a complete set of HTTP headers to a transport.
| Parameters | |
version:bytes | The HTTP version in use. |
code:bytes | The HTTP status code to write. |
reason:bytes | The HTTP reason phrase to write. |
headers:twisted.web.http_headers.Headers, or (for backwards compatibility purposes only) any iterable of two-tuples of bytes, representing header names and header values. The latter option is not actually used by Twisted. | The headers to write to the transport. |
The number of seconds to wait after we attempt to shut the transport down cleanly to give up and forcibly terminate it. This is only used when we time a connection out, to prevent errors causing the FD to get leaked. If this is None, we will wait forever.
This is a quick and dirty way of responding to bad requests.
As described by HTTP standard we should be patient and accept the whole request from the client before sending a polite bad request response, even in the case when clients send tons of data.
The twisted.internet.base.DelayedCall that will be used to forcibly close the transport if it doesn't close cleanly.
Either the transport, if it provides interfaces.IPushProducer, or a null implementation of interfaces.IPushProducer. Used to attempt to prevent the transport from producing excess data when we're responding to a request.
When a resource takes a long time to answer a request (via twisted.web.server.NOT_DONE_YET, hopefully one day by a Deferred), we would like to be able to let that resource know about the underlying transport disappearing as promptly as possible, via Request.notifyFinish, and therefore via self.requests[...].connectionLost() on this HTTPChannel.
However, in order to simplify application logic, we implement head-of-line blocking, and do not relay pipelined requests to the application until the previous request has been answered. This means that said application cannot dispose of any entity-body that comes in from those subsequent requests, which may be arbitrarily large, and it may need to be buffered in memory.
To implement this tradeoff between prompt notification when possible (in the most frequent case of non-pipelined requests) and correct behavior when not (say, if a client sends a very long-running GET request followed by a PUT request with a very large body) we will continue reading pipelined requests into self._dataBuffer up to a given limit.
_optimisticEagerReadSize is the number of bytes we will accept from the client and buffer before pausing the transport.
This behavior has been in place since Twisted 17.9.0 .
If the Request object or anything it calls registers itself as an interfaces.IProducer, it will be stored here. This is used to create a producing pipeline: pause/resume producing methods will be propagated from the transport, through the HTTPChannel instance, to the c{_requestProducer}.
The reason we proxy through the producing methods rather than the old behaviour (where we literally just set the Request object as the producer on the transport) is because we want to be able to exert backpressure on the client to prevent it from sending in arbitrarily many requests without ever reading responses. Essentially, if the client never reads our responses we will eventually stop reading its requests.
A boolean that tracks whether the producer on the Request side of this channel has registered itself as a interfaces.IPushProducer or an interfaces.IPullProducer.