1 files changed, 211 insertions, 0 deletions
diff --git a/plugins/VNLib.Data.Caching.Providers.VNCache/src/VNCacheClient.cs b/plugins/VNLib.Data.Caching.Providers.VNCache/src/VNCacheClient.cs
new file mode 100644
index 0000000..a832b41
--- /dev/null
+++ b/plugins/VNLib.Data.Caching.Providers.VNCache/src/VNCacheClient.cs
@@ -0,0 +1,211 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+* 
+* Library: VNLib
+* Package: VNLib.Data.Caching.Providers.VNCache
+* File: VNCacheClient.cs 
+*
+* VNCacheClient.cs is part of VNLib.Data.Caching.Providers.VNCache which is 
+* part of the larger VNLib collection of libraries and utilities.
+*
+* VNLib.Data.Caching.Providers.VNCache 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.Data.Caching.Providers.VNCache 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;
+using System.Text.Json;
+using System.Threading;
+using System.Threading.Tasks;
+
+using VNLib.Utils.Logging;
+using VNLib.Plugins;
+using VNLib.Plugins.Extensions.Loading;
+
+/*
+ * This package exports an IGlobalCacheProvider that is intended to be packaged by 
+ * application distributors that want to use VNCache as a global cache for their 
+ * application.
+ * 
+ * This package allows for memory only caching, write-through memory cache, and 
+ * direct remote caching using VNCache as the backend.
+ */
+
+namespace VNLib.Data.Caching.Providers.VNCache
+{
+
+    /// <summary>
+    /// The VNCache global cache provider client, that is intended to be loaded
+    /// using <see cref="LoadingExtensions.GetOrCreateSingleton{T}(PluginBase)"/> directly
+    /// on the plugin loading a cache client.
+    /// <para>
+    /// Users may also create cache instances outside of plugin context using static 
+    /// methods.
+    /// </para>
+    /// </summary>
+    [ExternService]
+    [ConfigurationName(CACHE_CONFIG_KEY)]
+    public sealed class VNCacheClient : IGlobalCacheProvider
+    {
+        internal const string CACHE_CONFIG_KEY = "cache";
+        internal const string MEMORY_CACHE_CONFIG_KEY = "memory_cache";
+        internal const string MEMORY_CACHE_ONLY_KEY = "memory_only";
+
+        private readonly IGlobalCacheProvider _client;
+
+        public VNCacheClient(PluginBase plugin, IConfigScope config)
+        {
+            if (config.TryGetValue(MEMORY_CACHE_CONFIG_KEY, out _))
+            {
+                //Check for memory only flag
+                if (config.TryGetValue(MEMORY_CACHE_ONLY_KEY, out JsonElement memOnly) && memOnly.GetBoolean())
+                {
+                    //Create a memory-only cache
+                    _client = plugin.GetOrCreateSingleton<MemoryCache>();
+                }
+                else
+                {
+                    //Remote-backed memory cache
+                    _client = plugin.GetOrCreateSingleton<RemoteBackedMemoryCache>();
+                }
+            }
+            else
+            {
+                //Setup non-memory backed cache client
+                _client = plugin.GetOrCreateSingleton<FBMCacheClient>();
+            }
+        }
+
+
+        /// <summary>
+        /// Allows you to programatically create a remote-only VNCache instance
+        /// </summary>
+        /// <param name="config">The remote cache configuration, required for VNCache remote cache servers</param>
+        /// <param name="debugLog">An optional FBMClient debugging log provider, should be null unless debug logging is desired </param>
+        /// <returns>An opreator handle that can schedule the remote cache worker task</returns>
+        /// <exception cref="ArgumentNullException"></exception>
+        /// <remarks>
+        /// The returned <see cref="RemoteCacheOperator"/> implements the <see cref="IAsyncBackgroundWork"/>
+        /// interface and must be scheduled in order to maintain a connection with the remote cache store.
+        /// </remarks>
+        public static RemoteCacheOperator CreateRemoteCache(VnCacheClientConfig config, ILogProvider? debugLog = null)
+        {
+            _ = config ?? throw new ArgumentNullException(nameof(config));
+
+            //Init client
+            FBMCacheClient client = new(config, debugLog);
+
+            //Return single handle
+            return new(client, null);
+        }
+
+        /// <summary>
+        /// Allows you to programatically create your own instance if a VNCache remote server backed
+        /// memory cache programatically. 
+        /// </summary>
+        /// <param name="remote">The remote cache configuration, required for VNCache remote cache servers</param>
+        /// <param name="memory">The local memory backed configuration</param>
+        /// <param name="debugLog">An optional FBMClient debugging log provider, should be null unless debug logging is desired </param>
+        /// <returns>An opreator handle that can schedule the remote cache worker task</returns>
+        /// <exception cref="ArgumentNullException"></exception>
+        /// <remarks>
+        /// The returned <see cref="RemoteCacheOperator"/> implements the <see cref="IAsyncBackgroundWork"/>
+        /// interface and must be scheduled in order to maintain a connection with the remote cache store. The memory cache 
+        /// resources are released when the worker task exits.
+        /// </remarks>
+        public static RemoteCacheOperator CreateRemoteBackedMemoryCache(VnCacheClientConfig remote, MemoryCacheConfig memory, ILogProvider? debugLog)
+        {
+            _ = remote ?? throw new ArgumentNullException(nameof(remote));
+            _ = memory ?? throw new ArgumentNullException(nameof(memory));
+
+            FBMCacheClient client = new(remote, debugLog);
+
+            //Init client
+            RemoteBackedMemoryCache memCache = new(memory, client);
+
+            //Return single handle
+            return new(client, memCache);
+        }
+
+        /// <summary>
+        /// Allows you to programatically create a memory only <see cref="IGlobalCacheProvider"/>
+        /// cache instance.
+        /// </summary>
+        /// <param name="config">The memory cache configuration</param>
+        /// <returns>
+        /// A <see cref="MemoryCacheOperator"/> handle that holds a ready-to use cache instance. 
+        /// This operator must be disposed to release held resources.
+        /// </returns>
+        /// <exception cref="ArgumentNullException"></exception>
+        public static MemoryCacheOperator CreateMemoryCache(MemoryCacheConfig config)
+        {
+            _ = config ?? throw new ArgumentNullException(nameof(config));
+
+            //Init client
+            MemoryCache cache = new(config);
+
+            //Return single handle
+            return new(cache);
+        }
+
+        ///<inheritdoc/>
+        public bool IsConnected => _client.IsConnected;
+
+        ///<inheritdoc/>
+        public Task AddOrUpdateAsync<T>(string key, string? newKey, T value, CancellationToken cancellation)
+        {
+            return _client.AddOrUpdateAsync(key, newKey, value, cancellation);
+        }
+
+        ///<inheritdoc/>
+        public Task AddOrUpdateAsync<T>(string key, string? newKey, T value, ICacheObjectSerializer serialzer, CancellationToken cancellation)
+        {
+            return _client.AddOrUpdateAsync(key, newKey, value, serialzer, cancellation);
+        }
+
+        ///<inheritdoc/>
+        public Task AddOrUpdateAsync<T>(string key, string? newKey, ObjectDataReader<T> callback, T state, CancellationToken cancellation)
+        {
+            return _client.AddOrUpdateAsync(key, newKey, callback, state, cancellation);
+        }
+
+        ///<inheritdoc/>
+        public Task<bool> DeleteAsync(string key, CancellationToken cancellation)
+        {
+            return _client.DeleteAsync(key, cancellation);
+        }
+
+        ///<inheritdoc/>
+        public Task<T?> GetAsync<T>(string key, CancellationToken cancellation)
+        {
+            return _client.GetAsync<T>(key, cancellation);
+        }
+
+        ///<inheritdoc/>
+        public Task<T?> GetAsync<T>(string key, ICacheObjectDeserializer deserializer, CancellationToken cancellation)
+        {
+            return _client.GetAsync<T>(key, deserializer, cancellation);
+        }
+
+        ///<inheritdoc/>
+        public Task GetAsync<T>(string key, ObjectDataSet<T> callback, T state, CancellationToken cancellation)
+        {
+            return _client.GetAsync(key, callback, state, cancellation);
+        }
+
+        ///<inheritdoc/>
+        public object GetUnderlyingStore()
+        {
+            return _client.GetUnderlyingStore();
+        }
+    }
+}