/*
* Copyright (c) 2022 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Sessions.Cache.Client
* File: IRemoteCacheStore.cs
*
* IRemoteCacheStore.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.Threading;
using System.Threading.Tasks;
namespace VNLib.Plugins.Sessions.Cache.Client
{
///
/// Represents an asynchronous interface to a remote cache store
///
public interface IRemoteCacheStore
{
///
/// Gets an object from the cache provider by key
///
/// The data type
/// The key/id of the object to recover
/// A token to cancel the operation
/// A task that resolves the found object or null otherwise
Task GetObjectAsync(string objectId, CancellationToken cancellationToken = default);
Task AddOrUpdateObjectAsync(string objectId, string? newId, T obj, CancellationToken cancellationToken = default);
Task DeleteObjectAsync(string objectId, CancellationToken cancellationToken = default);
///
/// Gets a value that determines if the remote cache store is available
///
bool IsConnected { get; }
}
}