pandemonium_engine/modules/web/doc_classes/HTTPSession.xml

58 lines
1.8 KiB
XML
Raw Normal View History

2022-08-21 00:40:49 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-08-23 13:09:12 +02:00
<class name="HTTPSession" inherits="Reference" version="3.8">
2022-08-21 00:40:49 +02:00
<brief_description>
The HTTPSession class represents a user's session.
2022-08-21 00:40:49 +02:00
</brief_description>
<description>
The HTTPSession class represents a user's session. It can store any kind data thanks to Variants. It's used by [HTTPSessionManager] in tandem with cookies to provide per session data storage facilities.
It contains a mutex, because a session / user can make more than one queries to a server at once (For example by opening multiple tabs in a browser), and these are handled by the framework asynchronously.
2022-08-21 00:40:49 +02:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add">
<return type="void" />
<argument index="0" name="key" type="String" />
<argument index="1" name="value" type="Variant" />
<description>
</description>
</method>
<method name="clear">
<return type="void" />
<description>
</description>
</method>
<method name="get_value">
<return type="Variant" />
<argument index="0" name="key" type="String" />
<description>
</description>
</method>
<method name="has">
<return type="bool" />
<argument index="0" name="key" type="String" />
<description>
</description>
</method>
<method name="remove">
<return type="void" />
<argument index="0" name="key" type="String" />
<description>
</description>
</method>
<method name="reset">
<return type="void" />
<description>
</description>
</method>
</methods>
<members>
<member name="id" type="int" setter="set_id" getter="get_id" default="0">
</member>
<member name="session_id" type="String" setter="set_session_id" getter="get_session_id" default="&quot;&quot;">
</member>
</members>
<constants>
</constants>
</class>