twisted.web.http.HTTPFactory(protocol.ServerFactory) class documentationtwisted.web.http
(View In Hierarchy)
Known subclasses: twisted.web.server.Site
Factory for HTTP server.
| Method | __init__ | |
| Method | buildProtocol | Create an instance of a subclass of Protocol. |
| Method | startFactory | Set up request logging if necessary. |
| Method | stopFactory | This will be called before I stop listening on all Ports/Connectors. |
| Method | log | Write a line representing request to the access log
file. |
| Instance Variable | _logDateTime | A cached datetime string for log messages, updated by
_logDateTimeCall. (type: str) |
| Instance Variable | _logDateTimeCall | A delayed call for the next update to the cached log datetime string. (type: IDelayedCall
provided) |
| Instance Variable | _logFormatter | See the logFormatter parameter to __init__ |
| Instance Variable | _nativeize | A flag that indicates whether the log file being written to wants native
strings (True) or bytes (False). This is only to
support writing to twisted.python.log which,
unfortunately, works with native strings. |
| Instance Variable | _reactor | An IReactorTime
provider used to compute logging timestamps. |
| Method | _updateLogDateTime | Update log datetime periodically, so we aren't always recalculating it. |
| Method | _openLogFile | Override in subclasses, e.g. to use twisted.python.logfile. |
Inherited from Factory (via ServerFactory):
| Class Method | forProtocol | Create a factory for the given protocol. |
| Method | logPrefix | Describe this factory for log messages. |
| Method | doStart | Make sure startFactory is called. |
| Method | doStop | Make sure stopFactory is called. |
IDelayedCall
provided)
True) or bytes (False). This is only to
support writing to twisted.python.log which,
unfortunately, works with native strings.
| Parameters | logPath | File path to which access log messages will be written or None
to disable logging. (type: str
or bytes) |
| timeout | The initial value of timeOut,
which defines the idle connection timeout in seconds, or None
to disable the idle timeout. (type: float) | |
| logFormatter | An object to format requests into log lines for the access log. combinedLogFormatter
when None is passed. (type: IAccessLogFormatter
provider) | |
| reactor | A IReactorTime
provider used to manage connection timeouts and compute logging timestamps. |
Update log datetime periodically, so we aren't always recalculating it.
Create an instance of a subclass of Protocol.
The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.
Alternatively, None
may be returned to immediately close the new connection.
Override this method to alter how Protocol instances get created.
| Parameters | addr | an object implementing twisted.internet.interfaces.IAddress |
This will be called before I stop listening on all Ports/Connectors.
This can be overridden to perform 'shutdown' tasks such as disconnecting database connections, closing files, etc.
It will be called, for example, before an application shuts down, if it was connected to a port. User code should not call this function directly.
Override in subclasses, e.g. to use twisted.python.logfile.
Write a line representing request to the access log
file.
| Parameters | request | The request object about which to log. (type: Request) |