diff options
author | vnugent <public@vaughnnugent.com> | 2023-01-12 17:47:40 -0500 |
---|---|---|
committer | vnugent <public@vaughnnugent.com> | 2023-01-12 17:47:40 -0500 |
commit | b75668b164d398b99ee942beced06aa27ef65a50 (patch) | |
tree | c1faf6df3caa78083dcc38eb1a7247e456bbe754 /VNLib.Data.Caching.Global/GlobalDataCache.cs | |
parent | cea64e619e714f6dbe51d37ca8329b58d8c271fb (diff) |
Large project reorder and consolidation
Diffstat (limited to 'VNLib.Data.Caching.Global/GlobalDataCache.cs')
-rw-r--r-- | VNLib.Data.Caching.Global/GlobalDataCache.cs | 169 |
1 files changed, 0 insertions, 169 deletions
diff --git a/VNLib.Data.Caching.Global/GlobalDataCache.cs b/VNLib.Data.Caching.Global/GlobalDataCache.cs deleted file mode 100644 index 3072aa2..0000000 --- a/VNLib.Data.Caching.Global/GlobalDataCache.cs +++ /dev/null @@ -1,169 +0,0 @@ -/* -* Copyright (c) 2022 Vaughn Nugent -* -* Library: VNLib -* Package: VNLib.Data.Caching.Global -* File: GlobalDataCache.cs -* -* GlobalDataCache.cs is part of VNLib.Data.Caching.Global which is part of the larger -* VNLib collection of libraries and utilities. -* -* VNLib.Data.Caching.Global is free software: you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published -* by the Free Software Foundation, either version 2 of the License, -* or (at your option) any later version. -* -* VNLib.Data.Caching.Global 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 -* General Public License for more details. -* -* You should have received a copy of the GNU General Public License -* along with VNLib.Data.Caching.Global. If not, see http://www.gnu.org/licenses/. -*/ - -using VNLib.Data.Caching.Global.Exceptions; - -namespace VNLib.Data.Caching.Global -{ - /// <summary> - /// A static library for caching data in-process or a remote data - /// cache - /// </summary> - public static class GlobalDataCache - { - - private static IGlobalCacheProvider? CacheProvider; - private static CancellationTokenRegistration _reg; - - private static readonly object CacheLock = new(); - private static readonly Dictionary<string, WeakReference<object>> LocalCache = new(); - - /// <summary> - /// Gets a value that indicates if global cache is available - /// </summary> - public static bool IsAvailable => CacheProvider != null && CacheProvider.IsConnected; - - /// <summary> - /// Sets the backing cache provider for the process-wide global cache - /// </summary> - /// <param name="cacheProvider">The cache provider instance</param> - /// <param name="statusToken">A token that represents the store's validity</param> - public static void SetProvider(IGlobalCacheProvider cacheProvider, CancellationToken statusToken) - { - CacheProvider = cacheProvider ?? throw new ArgumentNullException(nameof(cacheProvider)); - //Remove cache provider when cache provider is no longer valid - _reg = statusToken.Register(Cleanup); - } - - private static void Cleanup() - { - CacheProvider = null; - //Clear local cache - lock (CacheLock) - { - LocalCache.Clear(); - } - _reg.Dispose(); - } - - /// <summary> - /// Asynchronously gets a value from the global cache provider - /// </summary> - /// <typeparam name="T"></typeparam> - /// <param name="key">The key identifying the object to recover from cache</param> - /// <returns>The value if found, or null if it does not exist in the store</returns> - /// <exception cref="GlobalCacheException"></exception> - /// <exception cref="CacheNotLoadedException"></exception> - public static async Task<T?> GetAsync<T>(string key) where T: class - { - //Check local cache first - lock (CacheLock) - { - if (LocalCache.TryGetValue(key, out WeakReference<object>? wr)) - { - //Value is found - if(wr.TryGetTarget(out object? value)) - { - //Value exists and is loaded to local cache - return (T)value; - } - //Value has been collected - else - { - //Remove the key from the table - LocalCache.Remove(key); - } - } - } - //get ref to local cache provider - IGlobalCacheProvider? prov = CacheProvider; - if(prov == null) - { - throw new CacheNotLoadedException("Global cache provider was not found"); - } - //get the value from the store - T? val = await prov.GetAsync<T>(key); - //Only store the value if it was successfully found - if (val != null) - { - //Store in local cache - lock (CacheLock) - { - LocalCache[key] = new WeakReference<object>(val); - } - } - return val; - } - - /// <summary> - /// Asynchronously sets (or updates) a cached value in the global cache - /// </summary> - /// <typeparam name="T"></typeparam> - /// <param name="key">The key identifying the object to recover from cache</param> - /// <param name="value">The value to set at the given key</param> - /// <returns>A task that completes when the update operation has compelted</returns> - /// <exception cref="GlobalCacheException"></exception> - /// <exception cref="CacheNotLoadedException"></exception> - public static async Task SetAsync<T>(string key, T value) where T : class - { - //Local record is stale, allow it to be loaded from cache next call to get - lock (CacheLock) - { - LocalCache.Remove(key); - } - //get ref to local cache provider - IGlobalCacheProvider? prov = CacheProvider; - if (prov == null) - { - throw new CacheNotLoadedException("Global cache provider was not found"); - } - //set the value in the store - await prov.AddOrUpdateAsync<T>(key, null, value); - } - - /// <summary> - /// Asynchronously deletes an item from cache by its key - /// </summary> - /// <param name="key"></param> - /// <returns>A task that completes when the delete operation has compelted</returns> - /// <exception cref="GlobalCacheException"></exception> - /// <exception cref="CacheNotLoadedException"></exception> - public static async Task DeleteAsync(string key) - { - //Delete from local cache - lock (CacheLock) - { - LocalCache.Remove(key); - } - //get ref to local cache provider - IGlobalCacheProvider? prov = CacheProvider; - if (prov == null) - { - throw new CacheNotLoadedException("Global cache provider was not found"); - } - //Delete value from store - await prov.DeleteAsync(key); - } - } -}
\ No newline at end of file |