class documentation

class twisted.web.http.HTTPFactory(protocol.ServerFactory): (source)

Known subclasses: twisted.web.server.Site

View In Hierarchy

Factory for HTTP server.

Instance Variable logPath Undocumented
Method __init__
Instance Variable timeOut Undocumented
Method buildProtocol Create an instance of a subclass of Protocol.
Method startFactory Set up request logging if necessary.
Instance Variable logFile Undocumented
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.
Instance Variable _logDateTimeCall A delayed call for the next update to the cached log datetime string.
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 Variable protocol Undocumented
Instance Variable numPorts Undocumented
Class Variable noisy Undocumented
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 = (source)
A cached datetime string for log messages, updated by _logDateTimeCall.
(type: str)
_logDateTimeCall = (source)
A delayed call for the next update to the cached log datetime string.
(type: IDelayedCall provided)
_logFormatter = (source)
See the logFormatter parameter to __init__
_nativeize = (source)
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 = (source)
An IReactorTime provider used to compute logging timestamps.
logPath = (source)

Undocumented

def __init__(self, logPath=None, timeout=_REQUEST_TIMEOUT, logFormatter=None, reactor=None): (source)
ParameterslogPathFile path to which access log messages will be written or None to disable logging. (type: str or bytes)
timeoutThe initial value of timeOut, which defines the idle connection timeout in seconds, or None to disable the idle timeout. (type: float)
logFormatterAn object to format requests into log lines for the access log. combinedLogFormatter when None is passed. (type: IAccessLogFormatter provider)
reactorA IReactorTime provider used to manage connection timeouts and compute logging timestamps.
timeOut = (source)

Undocumented

def _updateLogDateTime(self): (source)

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

def buildProtocol(self, addr): (source)

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)

Set up request logging if necessary.

logFile = (source)

Undocumented

def stopFactory(self): (source)

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)

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 20.12.1 at 2021-02-28 19:53:36.