Class t.w.s.Site(http.HTTPFactory):

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

A web site: manage log, sessions, and resources.
Instance Variablescounterincrement value used for generating unique sessions ID.
requestFactoryfactory creating requests objects. Default to Request.
displayTracebacksif set, Twisted internal errors are displayed on rendered pages. Default to True.
sessionFactoryfactory for sessions objects. Default to Session.
sessionCheckTimeinterval between each check of session expiration.

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
489 Method __init__ Initialize.
501 Method __getstate__ Undocumented
514 Method makeSession Generate a new Session instance, and store it for future reference.
523 Method getSession Get a previously generated session, by its unique ID.
530 Method buildProtocol Generate a channel attached to this site.
541 Method render Redirect because a Site is always a directory.
548 Method getChildWithDefault Emulate a resource's getChild method.
555 Method getResourceFor Get a resource for a request.
497 Method _openLogFile Override in subclasses, e.g. to use twisted.python.logfile.
506 Method _mkuid (internal) Generate an opaque, unique ID for a user's session.

Inherited from HTTPFactory:

Line # Kind Name Docs
1505 Method startFactory This will be called before I begin listening on a Port or Connector.
1512 Method stopFactory This will be called before I stop listening on all Ports/Connectors.
1532 Method log Log a request's result to the logfile, by default in combined log format.
1524 Method _escape Undocumented

Inherited from Factory (via HTTPFactory, ServerFactory):

Line # Kind Name Docs
39 Method doStart Make sure startFactory is called.
50 Method doStop Make sure stopFactory is called.
Line # Kind Name Docs
501 Method __getstate__ Undocumented
489 Method __init__ Initialize.
530 Method buildProtocol Generate a channel attached to this site.
39 Method doStart Make sure startFactory is called.
50 Method doStop Make sure stopFactory is called.
548 Method getChildWithDefault Emulate a resource's getChild method.
555 Method getResourceFor Get a resource for a request.
523 Method getSession Get a previously generated session, by its unique ID.
1532 Method log Log a request's result to the logfile, by default in combined log format.
514 Method makeSession Generate a new Session instance, and store it for future reference.
541 Method render Redirect because a Site is always a directory.
1505 Method startFactory This will be called before I begin listening on a Port or Connector.
1512 Method stopFactory This will be called before I stop listening on all Ports/Connectors.
1524 Method _escape Undocumented
506 Method _mkuid (internal) Generate an opaque, unique ID for a user's session.
497 Method _openLogFile Override in subclasses, e.g. to use twisted.python.logfile.
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 2008-10-26 16:12:37.