/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Data.Caching
* File: GlobalCacheExtensions.cs
*
* GlobalCacheExtensions.cs is part of VNLib.Data.Caching which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Data.Caching 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 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.Threading;
using System.Threading.Tasks;
using VNLib.Net.Messaging.FBM;
using VNLib.Data.Caching.Exceptions;
namespace VNLib.Data.Caching
{
///
/// Exports extension methods for the interface
///
public static class GlobalCacheExtensions
{
///
/// Asynchronously gets a value from the backing cache store and writes it to the
/// supplied data buffer
///
///
/// The key identifying the object to recover from cache
/// The
/// A token to cancel the async operation
/// A task that complets when the object data has been written to the data buffer
public static Task GetAsync(this IGlobalCacheProvider cache, string key, IObjectData rawData, CancellationToken cancellation)
{
ArgumentNullException.ThrowIfNull(cache);
return cache.GetAsync(key, static (cd, data) => cd.SetData(data), rawData, cancellation);
}
///
/// Asynchronously sets (or updates) a cached value in the backing cache store
/// from the supplied raw data
///
///
/// The key identifying the object to recover from cache
/// An optional key that will be changed for the new object
/// A token to cancel the async operation
/// The raw data to store at the given key
/// A task that completes when the update operation has compelted
public static Task AddOrUpdateAsync(this IGlobalCacheProvider cache, string key, string? newKey, IObjectData rawData, CancellationToken cancellation)
{
ArgumentNullException.ThrowIfNull(cache);
return cache.AddOrUpdateAsync(key, newKey, static cd => cd.GetData(), rawData, cancellation);
}
///
/// Asynchronously sets (or updates) a cached value in the backing cache store
/// from the supplied raw data
///
///
/// The key identifying the object to recover from cache
/// An optional key that will be changed for the new object
/// A token to cancel the async operation
/// The raw data to store at the given key
/// A task that completes when the update operation has compelted
public static Task AddOrUpdateAsync(this IGlobalCacheProvider cache, string key, string? newKey, ReadOnlyMemory rawData, CancellationToken cancellation)
{
ArgumentNullException.ThrowIfNull(cache);
return cache.AddOrUpdateAsync(key, newKey, static cd => cd.Span, rawData, cancellation);
}
///
/// Gets an object from the server if it exists
///
///
///
///
/// The id of the object to get
/// A token to cancel the operation
/// A callback function that computes an object result from binary data
/// A user-state parameter to be passed back to the callback function
/// A task that completes to return the results of the response payload
///
///
///
///
///
public static async Task GetAsync(
this IGlobalCacheProvider cache,
string objectId,
GetObjectFromData getter,
TState state,
CancellationToken cancellationToken = default
)
{
ArgumentNullException.ThrowIfNull(cache);
ArgumentNullException.ThrowIfNull(getter);
//Get state will store the object result if successfull get operation
GetObjectState st = new(state, getter);
//Get the object, if successfull, compute the result
await cache.GetAsync(objectId, static (s, d) => s.ComputeResult(d), st, cancellationToken);
//If the get operation failed, return a default value
return st.Result;
}
///
/// Asynchronously gets a value from the backing cache store
///
///
///
/// The key identifying the object to recover from cache
/// A token to cancel the async operation
/// The value if found, or null if it does not exist in the store
public static Task GetAsync(this IGlobalCacheProvider cache, string key, CancellationToken cancellation)
{
ArgumentNullException.ThrowIfNull(cache);
return cache.GetAsync(key, cache.DefaultDeserializer, cancellation);
}
///
/// Asynchronously sets (or updates) a cached value in the backing cache store
///
///
///
/// The key identifying the object to recover from cache
/// An optional key that will be changed for the new object
/// A token to cancel the async operation
/// The value to set at the given key
/// A task that completes when the update operation has compelted
public static Task AddOrUpdateAsync(this IGlobalCacheProvider cache, string key, string? newKey, T value, CancellationToken cancellation)
{
ArgumentNullException.ThrowIfNull(cache);
return cache.AddOrUpdateAsync(key, newKey, value, cache.DefaultSerializer, cancellation);
}
}
}