WebKit.SessionDynamicStore
index
/usr/local/share/webware/WebKit/SessionDynamicStore.py

 
Modules
       
WebKit.SessionFileStore
WebKit.SessionMemoryStore
os
threading
time

 
Classes
       
WebKit.SessionStore.SessionStore(WebKit.Object.Object)
SessionDynamicStore

 
class SessionDynamicStore(WebKit.SessionStore.SessionStore)
    Stores the session in Memory and Files.
 
This can be used either in a persistent app server or a cgi framework.
 
To use this Session Store, set SessionStore in Application.config
to 'Dynamic'. Other variables which can be set in Application.config are:
 
'MaxDynamicMemorySessions', which sets the maximum number of sessions
that can be in the Memory SessionStore at one time. Default is 10,000.
 
'DynamicSessionTimeout', which sets the default time for a session to stay
in memory with no activity. Default is 15 minutes. When specifying this in
Application.config, use minutes.
 
 
Method resolution order:
SessionDynamicStore
WebKit.SessionStore.SessionStore
WebKit.Object.Object
__builtin__.object
MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:
MovetoFile(self, key)
MovetoMemory(self, key)
__delitem__(self, key)
__getitem__(self, key)
__init__(self, app)
__len__(self)
__setitem__(self, key, item)
cleanStaleSessions(self, task=None)
Clean stale sessions.
 
Called by the Application to tell this store to clean out all sessions
that have exceeded their lifetime.
We want to have their native class functions handle it, though.
 
Ideally, intervalSweep would be run more often than the
cleanStaleSessions functions for the actual stores.
This may need to wait until we get the TaskKit in place, though.
 
The problem is the FileStore.cleanStaleSessions can take a while to run.
So here, we only run the file sweep every fourth time.
clear(self)
has_key(self, key)
intervalSweep(self)
The session sweeper interval function.
 
The interval function moves sessions from memory to file
and can be run more often than the full cleanStaleSessions function.
keys(self)
memoryKeysInAccessTimeOrder(self)
Return memory store's keys in ascending order of last access time.
setEncoderDecoder(self, encoder, decoder)
setdefault(self, key, default)
storeAllSessions(self)
storeSession(self, session)

Methods inherited from WebKit.SessionStore.SessionStore:
__repr__(self)
application(self)
decoder(self)
encoder(self)
get(self, key, default=None)
items(self)
values(self)

Methods inherited from WebKit.Object.Object:
deprecated(self, method)
Output a deprecation warning.
 
The implementation of WebKit sometimes invokes this method which prints
a warning that the method you are using has been deprecated.
This method expects that deprecated methods say so at the beginning of
their doc string and terminate that msg with @. For example:
 
        DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @
 
Putting this information in the doc string is important for accuracy
in the generated docs.
 
Example call:
        deprecated(self.foo)

Data and other attributes inherited from WebKit.Object.Object:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'Object' objects>
list of weak references to the object (if defined)

Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
hasValueForKey(self, key)
Returns true if the key is available, although that does not
guarantee that there will not be errors caused by retrieving the key.
hasValueForName(self, keysString)
resetKeyBindings(self)
setValueForKey(self, key, value)
Suppose key is 'foo'. This method sets the value with the following precedence:
        1. Public attributes before private attributes
        2. Methods before non-methods
 
More specifically, this method then uses one of the following:
        @@ 2000-03-04 ce: fill in
 
...or invokes handleUnknownSetKey().
valueForKey(self, key, default=<class MiscUtils.NoDefault>)
Suppose key is 'foo'. This method returns the value with the following precedence:
        1. Methods before non-methods
        2. Public attributes before private attributes
 
More specifically, this method then returns one of the following:
        * foo()
        * _foo()
        * self.foo
        * self._foo
 
...or default, if it was specified,
otherwise invokes and returns result of valueForUnknownKey().
Note that valueForUnknownKey(), normally returns an exception.
 
See valueForName() which is a more advanced version of this method that allows
multiple, qualified keys.
valueForKeySequence(self, listOfKeys, default=None)
valueForName(self, keysString, default=None)
Returns the value for the given keysString. This is the more advanced version of
valueForKey(), which can only handle single names. This method can handle
'foo', 'foo1.foo2', 'a.b.c.d', etc. It will traverse dictionaries if needed.
valueForUnknownKey(self, key, default)
# Errors
valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
Returns a list of values that match the given keys, each of which is passed
  through valueForName() and so could be of the form 'a.b.c'.
keys is a sequence. default is any kind of object. defaults is a sequence.
  forgive and includeNames is a flag.
If default is not None, then it is substituted when a key is not found.
Otherwise, if defaults is not None, then it's corresponding/parallel value
  for the current key is substituted when a key is not found.
Otherwise, if forgive=1, then unknown keys simply don't produce any values.
Otherwise, if default and defaults are None, and forgive=0, then the unknown
  keys will probably raise an exception through valueForUnknownKey() although
  that method can always return a final, default value.
if keys is None, then None is returned. If keys is an empty list, then None
  is returned.
Often these last four arguments are specified by key.
Examples:
        names = ['origin.x', 'origin.y', 'size.width', 'size.height']
        obj.valuesForNames(names)
        obj.valuesForNames(names, default=0.0)
        obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
        obj.valuesForNames(names, forgive=0)
@@ 2000-03-04 ce: includeNames is only supported when forgive=1.
        It should be supported for the other cases.
        It should be documented.
        It should be included in the test cases.

 
Data
        debug = 0