t.w.s.Site(http.HTTPFactory) : class documentation

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

A web site: manage log, sessions, and resources.
Instance Variable counter increment value used for generating unique sessions ID.
Instance Variable requestFactory factory creating requests objects. Default to Request.
Instance Variable displayTracebacks if set, Twisted internal errors are displayed on rendered pages. Default to True.
Instance Variable sessionFactory factory for sessions objects. Default to Session.
Instance Variable sessionCheckTime Deprecated. See Session.sessionTimeout instead.
Method __init__ Initialize.
Method __getstate__ Undocumented
Method makeSession Generate a new Session instance, and store it for future reference.
Method getSession Get a previously generated session, by its unique ID. This raises a KeyError if the session is not found.
Method buildProtocol Generate a channel attached to this site.
Method render Redirect because a Site is always a directory.
Method getChildWithDefault Emulate a resource's getChild method.
Method getResourceFor Get a resource for a request.
Method _openLogFile Override in subclasses, e.g. to use twisted.python.logfile.
Method _mkuid (internal) Generate an opaque, unique ID for a user's session.

Inherited from HTTPFactory:

Method startFactory Set up request logging if necessary.
Method stopFactory This will be called before I stop listening on all Ports/Connectors.
Method log Log a request's result to the logfile, by default in combined log format.
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)
Method _updateLogDateTime Update log datetime periodically, so we aren't always recalculating it.
Method _escape Undocumented

Inherited from Factory (via HTTPFactory, ServerFactory):

Method logPrefix Describe this factory for log messages.
Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
counter =
increment value used for generating unique sessions ID.
requestFactory =
factory creating requests objects. Default to Request.
displayTracebacks =
if set, Twisted internal errors are displayed on rendered pages. Default to True.
sessionFactory =
factory for sessions objects. Default to Session.
sessionCheckTime =
Deprecated. See Session.sessionTimeout instead.
def __init__(self, resource, logPath=None, timeout=60 * 60 * 12): (source)
overrides twisted.web.http.HTTPFactory.__init__
Initialize.
def _openLogFile(self, path): (source)
overrides twisted.web.http.HTTPFactory._openLogFile
Override in subclasses, e.g. to use twisted.python.logfile.
def __getstate__(self): (source)
Undocumented
def _mkuid(self): (source)
(internal) Generate an opaque, unique ID for a user's session.
def makeSession(self): (source)
Generate a new Session instance, and store it for future reference.
def getSession(self, uid): (source)
Get a previously generated session, by its unique ID. This raises a KeyError if the session is not found.
def buildProtocol(self, addr): (source)
from twisted.internet.interfaces.IProtocolFactory
overrides twisted.web.http.HTTPFactory.buildProtocol
Generate a channel attached to this site.
def render(self, request): (source)
Redirect because a Site is always a directory.
def getChildWithDefault(self, pathEl, request): (source)
Emulate a resource's getChild method.
def getResourceFor(self, request): (source)
Get a resource for a request.

This iterates through the resource heirarchy, calling getChildWithDefault on each resource it finds for a path element, stopping when it hits an element where isLeaf is true.

API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.