MaSession Class Reference
List of all members.
Detailed DescriptionSession data store to store user's state data.
The MaSession class provides persistent data storage for user's state data accross multiple requests. The MaSession is a subclass of the MprHashEntry class which allows MaSession instances to be stored in a MprHashTable for quick access by their session ID values.
- Stability classification:
- Evolving.
Constructor & Destructor Documentation
| MaSession::MaSession |
( |
MaHost *
|
host, |
|
|
char * |
sessionId, |
|
|
int |
timeout |
|
) |
|
|
| |
- Synopsis:
- Construct a new session data store.
- Overview:
- Sessions are created and associated with a serving host. The constructor is supplied a unique session ID that will be used as the key for the hash entry for the Session object.
- Parameters:
-
|
host |
Pointer to the host object owning the session. |
|
sessionId |
Pointer to a unique character string session identifier. |
|
timeout |
Timeout for the session in seconds. If after the timeout has expired and no session activity has occurred, the sesion will be disposed. |
- Stability classification:
- Evolving.
|
Member Function Documentation
| char * MaSession::getId |
( |
|
) |
[inline] |
|
| |
- Synopsis:
- Return the Session ID
- Overview:
- Return the session ID associated with this session. Session IDs are strings that are unique in the server responding to the request.
- Returns:
- Returns a pointer to the Session ID string. Do not free.
|
The documentation for this class was generated from the following files:
|