twisted.web.http.HTTPFactory(protocol.ServerFactory) class documentation

Part of twisted.web.http View Source (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.
_logDateTime =
A cached datetime string for log messages, updated by _logDateTimeCall. (type: str)
_logDateTimeCall =
A delayed call for the next update to the cached log datetime string. (type: IDelayedCall provided)
_logFormatter =
See the logFormatter parameter to __init__
_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.
_reactor =
An IReactorTime provider used to compute logging timestamps.
def __init__(self, logPath=None, timeout=60 * 60 * 12, logFormatter=None): (source)
overridden in twisted.web.server.Site
ParameterslogFormatterAn object to format requests into log lines for the access log. (type: IAccessLogFormatter provider)
def _updateLogDateTime(self): (source)

Update log datetime periodically, so we aren't always recalculating it.

def buildProtocol(self, addr): (source)
from twisted.internet.interfaces.IProtocolFactory
overrides twisted.internet.protocol.Factory.buildProtocol
overridden in twisted.web.server.Site

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.

Parametersaddran object implementing twisted.internet.interfaces.IAddress
def startFactory(self): (source)
overrides twisted.internet.protocol.Factory.startFactory

Set up request logging if necessary.

def stopFactory(self): (source)
overrides twisted.internet.protocol.Factory.stopFactory

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.

def _openLogFile(self, path): (source)
overridden in twisted.web.server.Site

Override in subclasses, e.g. to use twisted.python.logfile.

def log(self, request): (source)

Write a line representing request to the access log file.

ParametersrequestThe request object about which to log. (type: Request)
API Documentation for Twisted, generated by pydoctor at 2016-04-04 15:02:49.