SessionManager Class
From RemObjects Software
This is a RemObjects SDK Architecture entry
Feel free to add your notes to this topic below.
Overview (.NET)
This is the abstract base class for all session manager implementations. You will descend from this class when implementing a custom session manager, or use one of the existing descendants.
Namespace
Declaration (C#)
[LicenseProvider(typeof(ROLicenseProvider))] public abstract class SessionManager : System.ComponentModel.Component;
Hierarchy
- System.ComponentModel.Component
- RemObjects.SDK.Server.SessionManager
Properties
| | | |
|---|---|---|
| MaxSessions | Integer | Indicates the maximum number of sessions handled by the session manager component.
When a new session is requested and the number is exceeded, a TooManySessionsException exception is thrown. A value of 0 (the default) or less indicates that the number of sessions is unlimited. |
| Timeout | Integer | Determines the timeout (in seconds) after which sessions will be discarded if they have not been accessed.
The default value is 600 seconds (10 minutes). |
Methods
| | |
|---|---|
| DestroySession | |
| ExpireSessions | This method will expire all sessions in the Session Manager that have exceeded the timeout.
Note: SessionManager will regularly check for expired sessions automatically, but you can use this method to trigger an expiration cycle manually. |
| GetAllSessions | |
| GetExistingSession | |
| GetSession | |
| ReleaseSession |
Events
| | |
|---|---|
| OnSessionCreated | Gets triggered after a new Session has been created.
You can use it to perform initialization functions or fill the session with default values. |
| OnSessionDestroyed | Gets triggered after a new Session has been manually destroyed.
You can use it to perform cleanup for a specific session id. Note: The session has already been Disposed when the OnSessionDestroyed event fires. This event will not fire for sessions that expire. |
| OnSessionExpired | Gets triggered after a new Session has been expired.
You can use it to perform cleanup and/or inspect the values of the expired session. Note: The session has already been Disposed when the OnSessionExpired event fires. This event will not fire for sessions that are manually destroyed. |
See Also
Product: RemObjects SDK
Current version: RemObjects SDK 'Vinci' (5.0)
Lists — Glossary — Features — How To — Components — Tools — Samples — Articles — Architecture — Issues
Categories: Text | RemObjects SDK | Architecture | Class | Component | .NET
