| Object: session-control-mixin (The :gwl Package) |
| Mixins: vanilla-mixin |
| Input Slots (optional) | |
| hidden? [from vanilla-mixin*] boolean | |
Indicates whether the object should effectively be a hidden-object even if specified in :objects. Default is nil. | |
| org-type | |
Type of original object, useful when viewing session report log | |
| recovery-expires-at expiration time of the recovery object | |
After the recovery object has replaced the orginal instance at what time should the recovery instance expire? | |
| recovery-url | |
Url to which a user will be redirected if requesting a session that has been cleared | |
| root [from vanilla-mixin*] gdl instance | |
The root-level node in this object's ``tree'' (instance hierarchy). | |
| safe-children [from vanilla-mixin*] list of gdl instances | |
All objects from the :objects specification, including elements of sequences as flat lists. Any children which throw errors come back as a plist with error information | |
| session-duration | |
Length of time a session should last without activity in minutes | |
| strings-for-display [from vanilla-mixin*] string or list of strings | |
Determines how the name of objects of this type will be printed in most places. This defaults to the name-for-display (generally the part's name as specified in its parent), followed by an index number if the part is an element of a sequence. | |
| use-recovery-object? boolean | |
Determines whether expired sessions are replaced by recovery object. Default is nil. | |
| visible-children [from vanilla-mixin*] list of gdl instances | |
Additional objects to display in Tatu tree. Typically this would be a subset of hidden-children. Defaults to NIL. | |
| Input Slots (optional, settable) | |
| expires-at | |
Universal time after which the session should expire | |
| GDL Functions | |
| clear-expired-session | |
This is the function called to check for and handle session control
| |
| clear-now? boolean | |
Test to run to see if this session has expired and needs to be cleared now. | |
| session-clean-up gets called right before the instance is going to get cleared | |
Is intended to be used to stop any instance states that may not be elequently handled by the garbage collector. ie database connections, multiprocessing locks, open streams etc. | |
| set-expires-at | |
Method which will set the expires-at slot to the current time + the session-duration | |