diff options
Diffstat (limited to 'lib/VNLib.Data.Caching.ObjectCache/src/IBlobCacheBucket.cs')
-rw-r--r-- | lib/VNLib.Data.Caching.ObjectCache/src/IBlobCacheBucket.cs | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/lib/VNLib.Data.Caching.ObjectCache/src/IBlobCacheBucket.cs b/lib/VNLib.Data.Caching.ObjectCache/src/IBlobCacheBucket.cs new file mode 100644 index 0000000..4876c5f --- /dev/null +++ b/lib/VNLib.Data.Caching.ObjectCache/src/IBlobCacheBucket.cs @@ -0,0 +1,58 @@ +/* +* Copyright (c) 2023 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Data.Caching.ObjectCache +* File: ObjectCacheStore.cs +* +* ObjectCacheStore.cs is part of VNLib.Data.Caching.ObjectCache which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Data.Caching.ObjectCache 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.ObjectCache 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; + +namespace VNLib.Data.Caching.ObjectCache +{ + /// <summary> + /// Represents a singe cache bucket that maintains cache concurrent <see cref="IBlobCache"/> + /// operations. + /// </summary> + public interface IBlobCacheBucket : IDisposable + { + /// <summary> + /// Gets a <see cref="CacheBucketHandle"/> that holds an exclusive lock + /// for the current bucekt and holds a referrence to the stored + /// <see cref="IBlobCache"/> + /// </summary> + /// <param name="cancellation">A token to cancel the wait operation</param> + /// <returns>A <see cref="CacheBucketHandle"/> that holds the <see cref="IBlobCache"/> referrence</returns> + ValueTask<CacheBucketHandle> WaitAsync(CancellationToken cancellation); + + /// <summary> + /// Allows for waiting for the cache directly, IE without receiving a lock handle + /// </summary> + /// <param name="cancellation"></param> + /// <returns>The underlying <see cref="IBlobCache"/> that now has exlcusive access</returns> + ValueTask<IBlobCache> ManualWaitAsync(CancellationToken cancellation); + + /// <summary> + /// Releases an exlcusive lock on the current bucket, DO NOT CALL BY USER CODE + /// </summary> + void Release(); + } +} |