t.w.s.Session(components.Componentized) : class documentation

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

A user's session with a system.

This utility class contains no functionality, but is used to represent a session.

Instance Variable uid A unique identifier for the session, bytes.
Instance Variable sessionTimeout timeout of a session, in seconds.
Instance Variable loopFactory Deprecated in Twisted 9.0. Does nothing. Do not use.
Method __init__ Initialize a session with a unique ID for that session.
Method startCheckingExpiration Start expiration tracking.
Method notifyOnExpire Call this callback when the session expires or logs out.
Method expire Expire/logout of the session.
Method touch Notify session modification.
Method checkExpired Deprecated; does nothing.
Instance Variable _reactor An object providing IReactorTime to use for scheduling expiration.

Inherited from Componentized:

Method locateAdapterClass Undocumented
Method setAdapter Cache a provider for the given interface, by adapting self using the given adapter class.
Method addAdapter Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument.
Method setComponent Cache a provider of the given interface.
Method addComponent Add a component to me, for all appropriate interfaces.
Method unsetComponent Remove my component specified by the given interface class.
Method removeComponent Remove the given component from me entirely, for all interfaces for which it has been registered.
Method getComponent Create or retrieve an adapter for the given interface.
Method __conform__ Undocumented
uid =
A unique identifier for the session, bytes.
_reactor =
An object providing IReactorTime to use for scheduling expiration.
sessionTimeout =
timeout of a session, in seconds.
loopFactory =
Deprecated in Twisted 9.0. Does nothing. Do not use.
def __init__(self, site, uid, reactor=None): (source)
overrides twisted.python.components.Componentized.__init__
Initialize a session with a unique ID for that session.
def startCheckingExpiration(self, lifetime=None): (source)
Start expiration tracking.
ParameterslifetimeIgnored; deprecated.
ReturnsNone
def notifyOnExpire(self, callback): (source)
Call this callback when the session expires or logs out.
def expire(self): (source)
Expire/logout of the session.
def touch(self): (source)
Notify session modification.
def checkExpired(self): (source)
Deprecated; does nothing.
API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.