lemon.session.drivers.db.DB

Package lemon :: Package session :: Package drivers :: Module db :: Class DB

[show private | hide private]

Class DB

Base --+
       |
      DB

The main session class for database storage of sessions.
See the information in lemon.session.start() for details of how to use it. The class should not be called 
directly becuase error-checking occurs in lemon.session.start().

Method Summary
	`__init__(self, app, expires, sessionID, cookie, seed, cleanup, database, table)` Initialise the class with the parameters as specified in the lemon.session.start() function.
	`_addSession(self, sessionID, length)` Create a new session setting the 'Created' and 'Accessed' variables.
	`_cleanupSessions(self)` Remove all expired sessions.
	`_delete(self, key)` Removes the variable from the session store.
	`_get(self, key, app, pickleValue)` Gets the variable 'key' from the session store.
	`_removeSession(self, sessionID)` Remove session information from the session store.
	`_sessionExists(self, sessionID)` Returns True if the session already exists, False otherwise.
	`_set(self, key, value, app, pickleValue)` Sets the variable 'key' to the value 'value' after pickling it.
Inherited from Base
	`__delitem__(self, key)` Allows the use of a dictionary-style interface to the session class.
	`__getitem__(self, key)` Allows the use of a dictionary-style interface to the session class.
	`__setitem__(self, key, value)` Allows the use of a dictionary-style interface to the session class.
	`begin(self)`
	`blockVariable(self, key)` Deprecated.
	`created(self)` Find out if a session was automatically created and hence whether this was the first visit.
	`delete(self, key)` Public method to remove a session variable.
	`destroy(self)` End a session and remove the session cookie.
	`get(self, key)` Public method to retrieve a session variable.
	`getParam(self, param)` Get the value of one of the params specified in lemon.session.start()...
	`release(self, key)` Allow a user to use the previously reserved variable name 'key'.
	`reserve(self, key)` Prevent a user using the variable name 'key'.
	`set(self, key, value)` Public method to set a session variable.
	`unblockVariable(self, key)` Deprecated.
	`_createSession(self, length)` Private method to start a new session.
	`_genSessionID(self, st)` Private method to generate a new sessionID.
	`_readCookie(self)` Private method to read the sessionID from the session cookie.
	`_removeCookie(self)` Private method to remove session cookie.
	`_setCookie(self, length)` Private method to set the session cookie with the options specified by the cookie param in ...

Method Details

init(self, app, expires, sessionID, cookie, seed, cleanup, database, table)
(Constructor)

Initialise the class with the parameters as specified in the lemon.session.start() function.

Overrides:: lemon.session.drivers.base.Base.__init__

_addSession(self, sessionID, length)

Create a new session setting the 'Created' and 'Accessed' variables.

Overrides:: lemon.session.drivers.base.Base._addSession

_cleanupSessions(self)

Remove all expired sessions.

Overrides:: lemon.session.drivers.base.Base._cleanupSessions

_delete(self, key)

Removes the variable from the session store.

Overrides:: lemon.session.drivers.base.Base._delete

_get(self, key, app=None, pickleValue=True)

Gets the variable 'key' from the session store.

Overrides:: lemon.session.drivers.base.Base._get

_removeSession(self, sessionID)

Remove session information from the session store.

Overrides:: lemon.session.drivers.base.Base._removeSession

_sessionExists(self, sessionID)

Returns True if the session already exists, False otherwise.

Overrides:: lemon.session.drivers.base.Base._sessionExists

_set(self, key, value, app=None, pickleValue=True)

Sets the variable 'key' to the value 'value' after pickling it. # XXX The app functionality is not tested

Overrides:: lemon.session.drivers.base.Base._set

Generated by Epydoc 2.0 on Mon Nov 10 15:07:58 2003

http://epydoc.sf.net

Class DB

__init__(self, app, expires, sessionID, cookie, seed, cleanup, database, table) (Constructor)

_addSession(self, sessionID, length)

_cleanupSessions(self)

_delete(self, key)

_get(self, key, app=None, pickleValue=True)

_removeSession(self, sessionID)

_sessionExists(self, sessionID)

_set(self, key, value, app=None, pickleValue=True)

init(self, app, expires, sessionID, cookie, seed, cleanup, database, table)
(Constructor)