aboutsummaryrefslogtreecommitdiff
path: root/Libs/VNLib.Plugins.Essentials.Sessions/VNLib.Plugins.Essentials.Sessions.Memory.xml
blob: 0821935197b3dd18147213ec54c7f65c91766998 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<?xml version="1.0"?>
<!--
Copyright (c) 2022 Vaughn Nugent
-->
<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>