twisted.web.server.Session

class documentation

class twisted.web.server.Session(components.Componentized): (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.
Instance Variable sessionTimeout timeout of a session, in seconds.
Method __init__ Initialize a session with a unique ID for that session.
Instance Variable site Undocumented
Instance Variable expireCallbacks Undocumented
Instance Variable sessionNamespaces Undocumented
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.
Instance Variable lastModified Undocumented
Instance Variable _reactor An object providing IReactorTime to use for scheduling expiration.
Instance Variable _expireCall Undocumented

Inherited from Componentized:

Class Variable persistenceVersion Undocumented
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
Instance Variable _adapterCache Undocumented
uid = (source)
A unique identifier for the session.
(type: bytes)
_reactor = (source)
An object providing IReactorTime to use for scheduling expiration.
sessionTimeout = (source)
timeout of a session, in seconds.
(type: int)
_expireCall = (source)

Undocumented

def __init__(self, site, uid, reactor=None): (source)
overrides twisted.python.components.Componentized.__init__

Initialize a session with a unique ID for that session.

site = (source)

Undocumented

expireCallbacks = (source)

Undocumented

(type: list)
sessionNamespaces = (source)

Undocumented

(type: dict)
def startCheckingExpiration(self): (source)

Start expiration tracking.

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.

lastModified = (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.