Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-02-23 16:04:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added description for HTTPSessionManager. Note that this class still needs more cleanups, but I wrote docs in a way as if those were already done.

Browse Source
This commit is contained in:
Relintai 2022-08-21 03:04:13 +02:00
parent 892cff7537
commit 8119bd099a
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
modules/web/doc_classes/HTTPSessionManager.xml
View File

@ -1,8 +1,14 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="HTTPSessionManager" inherits="Node" version="3.7">
<brief_description>
The [HTTPSessionManager] class stores active sessions on a server.
</brief_description>
<description>
The [HTTPSessionManager] class stores active sessions on a server, and also has helper methods to create, save and delete sessions.
It should be placed as a child of a [WebServer], which will automatically pick it up. [WebNode]s should access it using the helper methods in [WebServerRequest].
The [SessionSetupWebServerMiddleware] is meant to be used alongside this class, which will automatically take session id from a request's cookie (if exists), and if it exists it will set the HTTPSession belonging to that id to the Request's session variable. Note that this will not create sessions automatically.
Although sessions can be created and set up manually, the [WebServerRequest] class also offers helper methods to do this.
Note that this class won't save the created sessions. Use one of it's inheritors, or inherit from it to implement your own serialization.
</description>
<tutorials>
</tutorials>