From a8510fb835dcc5e1142d700164ce5a4bd44e1a25 Mon Sep 17 00:00:00 2001
From: vman <public@vaughnnugent.com>
Date: Sun, 30 Oct 2022 02:28:12 -0400
Subject: Add project files.

---
 .../VNLib.Plugins.Essentials.Sessions.Memory.xml   | 75 ++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 Libs/VNLib.Plugins.Essentials.Sessions/VNLib.Plugins.Essentials.Sessions.Memory.xml

(limited to 'Libs/VNLib.Plugins.Essentials.Sessions/VNLib.Plugins.Essentials.Sessions.Memory.xml')

diff --git a/Libs/VNLib.Plugins.Essentials.Sessions/VNLib.Plugins.Essentials.Sessions.Memory.xml b/Libs/VNLib.Plugins.Essentials.Sessions/VNLib.Plugins.Essentials.Sessions.Memory.xml
new file mode 100644
index 0000000..9c596c3
--- /dev/null
+++ b/Libs/VNLib.Plugins.Essentials.Sessions/VNLib.Plugins.Essentials.Sessions.Memory.xml
@@ -0,0 +1,75 @@
+<?xml version="1.0"?>
+<doc>
+    <assembly>
+        <name>VNLib.Plugins.Essentials.Sessions.Memory</name>
+    </assembly>
+    <members>
+        <member name="T:VNLib.Plugins.Essentials.Sessions.Memory.MemorySessionStore">
+            <summary>
+            An <see cref="T:VNLib.Plugins.Essentials.Sessions.ISessionProvider"/> for in-process-memory backed sessions
+            </summary>
+        </member>
+        <member name="M:VNLib.Plugins.Essentials.Sessions.Memory.MemorySessionStore.GetSessionAsync(VNLib.Net.Http.HttpEvent,System.Threading.CancellationToken)">
+            <inheritdoc/>
+        </member>
+        <member name="P:VNLib.Plugins.Essentials.Sessions.Memory.MemorySessionStore.NewSessionID">
+            <summary>
+            Gets a new unique sessionid for sessions
+            </summary>
+        </member>
+        <member name="M:VNLib.Plugins.Essentials.Sessions.Memory.MemorySessionStore.SetSessionCookie(VNLib.Net.Http.HttpEvent,VNLib.Plugins.Essentials.Sessions.Memory.MemorySession)">
+            <summary>
+            Sets a standard session cookie for an entity/connection
+            </summary>
+            <param name="entity">The entity to set the cookie on</param>
+            <param name="session">The session attached to the </param>
+        </member>
+        <member name="M:VNLib.Plugins.Essentials.Sessions.Memory.MemorySessionStore.Cleanup">
+            <summary>
+            Evicts all sessions from the current store
+            </summary>
+        </member>
+        <member name="M:VNLib.Plugins.Essentials.Sessions.Memory.MemorySessionStore.GC">
+            <summary>
+            Collects all expired records from the current store
+            </summary>
+        </member>
+        <member name="T:VNLib.Plugins.Essentials.Sessions.Memory.MemSessionHandle">
+            <summary>
+            Provides a one-time-use handle (similar to asyncReleaser, or openHandle) 
+            that holds exclusive access to a session until it is released
+            </summary>
+        </member>
+        <member name="T:VNLib.Net.Sessions.MemorySessionConfig">
+            <summary>
+            Represents configration variables used to create and operate http sessions. 
+            </summary>
+        </member>
+        <member name="P:VNLib.Net.Sessions.MemorySessionConfig.SessionCookieID">
+            <summary>
+            The name of the cookie to use for matching sessions
+            </summary>
+        </member>
+        <member name="P:VNLib.Net.Sessions.MemorySessionConfig.SessionIdSizeBytes">
+            <summary>
+            The size (in bytes) of the genreated SessionIds
+            </summary>
+        </member>
+        <member name="P:VNLib.Net.Sessions.MemorySessionConfig.SessionTimeout">
+            <summary>
+            The amount of time a session is valid (within the backing store)
+            </summary>
+        </member>
+        <member name="P:VNLib.Net.Sessions.MemorySessionConfig.SessionLog">
+            <summary>
+            The log for which all errors within the <see cref="!:SessionProvider"/> instance will be written to. 
+            </summary>
+        </member>
+        <member name="P:VNLib.Net.Sessions.MemorySessionConfig.MaxAllowedSessions">
+            <summary>
+            The maximum number of sessions allowed to be cached in memory. If this value is exceed requests to this 
+            server will be denied with a 503 error code
+            </summary>
+        </member>
+    </members>
+</doc>
-- 
cgit