aboutsummaryrefslogtreecommitdiff
path: root/libs/VNLib.Plugins.Sessions.Cache.Client/src/ISessionSerialzer.cs
diff options
context:
space:
mode:
authorLibravatar vnugent <public@vaughnnugent.com>2023-03-09 01:48:40 -0500
committerLibravatar vnugent <public@vaughnnugent.com>2023-03-09 01:48:40 -0500
commitd673bd34945699df96e38c54f70352608430fbc4 (patch)
treedd5e17d02f3fe73e4d1a54689bd9c7d41f1a5a71 /libs/VNLib.Plugins.Sessions.Cache.Client/src/ISessionSerialzer.cs
parent11a8cea8a6445bd5127eb4c97fc582cd944f72ea (diff)
Omega cache, session, and account provider complete overhaul
Diffstat (limited to 'libs/VNLib.Plugins.Sessions.Cache.Client/src/ISessionSerialzer.cs')
-rw-r--r--libs/VNLib.Plugins.Sessions.Cache.Client/src/ISessionSerialzer.cs46
1 files changed, 46 insertions, 0 deletions
diff --git a/libs/VNLib.Plugins.Sessions.Cache.Client/src/ISessionSerialzer.cs b/libs/VNLib.Plugins.Sessions.Cache.Client/src/ISessionSerialzer.cs
new file mode 100644
index 0000000..40bfa7b
--- /dev/null
+++ b/libs/VNLib.Plugins.Sessions.Cache.Client/src/ISessionSerialzer.cs
@@ -0,0 +1,46 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: VNLib.Plugins.Sessions.Cache.Client
+* File: ISessionSerialzer.cs
+*
+* ISessionSerialzer.cs is part of VNLib.Plugins.Sessions.Cache.Client which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* VNLib.Plugins.Sessions.Cache.Client is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Affero General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* VNLib.Plugins.Sessions.Cache.Client is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Affero General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program. If not, see https://www.gnu.org/licenses/.
+*/
+
+using System.Diagnostics.CodeAnalysis;
+
+using VNLib.Utils.Async;
+
+namespace VNLib.Plugins.Sessions.Cache.Client
+{
+ /// <summary>
+ /// A specialized <see cref="IAsyncAccessSerializer{TMoniker}"/>
+ /// that allows for re-using an instance that may be awaited
+ /// </summary>
+ /// <typeparam name="TSession">The session type</typeparam>
+ public interface ISessionSerialzer<TSession> : IAsyncAccessSerializer<TSession>
+ {
+ /// <summary>
+ /// Attempts to get an active session in the wait table as an atomic operation
+ /// </summary>
+ /// <param name="sessionId">The id of the session to retreive from the store</param>
+ /// <param name="session">The stored session</param>
+ /// <returns>A value that inidcates if the session was found</returns>
+ bool TryGetSession(string sessionId, [NotNullWhen(true)] out TSession? session);
+ }
+}