[Zope-CVS] CVS: Products/Transience/help - Transience.stx:1.2
Matthew T. Kromer
Tue, 23 Oct 2001 16:29:27 -0400
Update of /cvs-repository/Products/Transience/help
In directory cvs.zope.org:/tmp/cvs-serv26339/help
Updated Transience & help to match
=== Products/Transience/help/Transience.stx 1.1 => 1.2 === (1431/1531 lines abridged)
+Transient Object Documentation
-Core Session Tracking Release 0.9 Documentation
+ This is the documentation to the Transience product.
- This is the documentation to the Core Session Tracking product.
- Session tracking allows you to keep state between HTTP requests for
- anonymous users.
- The Big Picture
- There are four major components to the CoreSessionTracking design:
- - Session Id Manager -- this is the component which determines a
- remote client's session id. The session id is contained in the
- "session token", which is encoded in a form or cookie variable.
- The session id manager examines and modifies cookie and
- form variables to determine or set the client's session id.
- There may be more than one session id manager in a Zope
- installation, but commonly there will only be one. Application
- developers will generally not talk directly to a session id
- manager. Instead, they will talk to session data managers,
- which will delegate some calls to a session id manager. Session
- id managers have "fixed" Zope ids so they can be found via
- acquisition by session data managers.
- - Session Data Manager -- this is the component which is
- responsible for handing out session data to callers. When
- session data is required, the session data manager talks to a
- session id manager to determine the current session token and
- creates a new session data object or hands back an existing
- session data object based on the token. It also has interfaces
- for encoding a URL with session information and performing other
- utility functions. Developers will generally use methods of
- session data managers to obtain session data objects when
- writing application code. Many session data managers can use
- one session id manager. Many session data managers can be
- instantiated on a single Zope installation. Different session
- data managers can implement different policies related to
- session data object storage (e.g. to which session data
- container the session data objects are stored).
- - Session Data Container -- this is the component which actually
- holds information related to sessions. Currently, it is used to
- hold a special "session data object" instance for each ongoing
- session. Developers will generally not interact with session
- data containers. The current implementation defines two types
- of session data containers: internal and external. "Internal"
- session data containers are RAM-based, and they are available
- for use on a per-session-data-manager basis, while "external"
[-=- -=- -=- 1431 lines omitted -=- -=- -=-]
+ Returns a list of (key, value) pairs for all keys in the object.
+ get(key, default=None)
+ Returns the value corresponding to the given key. If the key does
+ not exist, and a default is specified, the default is returned,
+ otherwise a KeyError will be raised.
+ Tests to see if the given key exists in the TransientObject. If the
+ key exists, a 1 will be returned, otherwise a 0 will be returned.
+ Removes all values from the TransientObject.
+ Updates the TransientObject from the dictionary provided, copying
+ keys and values from the dictionary into the TransientObject.
+ Interface TTWDictionary
+ set(key, value)
+ Sets the value for a specific key in the TransientObject.
+ Removes a key/value pair from the TransientObject.
+ Interface ImmutablyValuedMappingOfPickleableObjects
+ _ _setitem_ _(key, value)
+ Sets the value for a specific key in the TransientObject. If
+ the key or value is acquisition wrapped, it is unwrapped prior
+ to storage.
+ _ _getitem_ _(key)
+ Retrieves the value for the given key in the TransientObject.
+ _ _delitem_ _(key)
+ Deletes the given key from the TransientObject.