/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: ObjectCacheServer
* File: ICacheStore.cs
*
* ICacheStore.cs is part of ObjectCacheServer which is part of the larger
* VNLib collection of libraries and utilities.
*
* ObjectCacheServer 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.
*
* ObjectCacheServer 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.Threading;
using System.Threading.Tasks;
namespace VNLib.Data.Caching.ObjectCache.Server
{
internal interface ICacheStore
{
///
/// Asynchronously adds or updates an object in the store and optionally update's its id
///
/// The current (or old) id of the object
/// An optional id to update the blob to
/// A callback that returns the data for the blob
/// The state parameter to pass to the data callback
/// A token to cancel the async operation
/// A value task that represents the async operation
ValueTask AddOrUpdateBlobAsync(string objectId, string? alternateId, ObjectDataGet bodyData, T state, CancellationToken token = default);
///
/// Clears all items from the store
///
void Clear();
///
/// Asynchronously deletes a previously stored item
///
/// The id of the object to delete
/// A token to cancel the async lock await
/// A task that completes when the item has been deleted
ValueTask DeleteItemAsync(string id, CancellationToken token = default);
}
}