lib/VNLib.Data.Caching.ObjectCache/src/ICacheMemoryManagerFactory.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Data.Caching.ObjectCache
* File: ICacheMemoryManagerFactory.cs 
*
* ICacheMemoryManagerFactory.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/.
*/

namespace VNLib.Data.Caching.ObjectCache
{
    /// <summary>
    /// Provides bucket-local memory managers for <see cref="IBlobCacheBucket"/>s
    /// to use for their internal memory management
    /// </summary>
    public interface ICacheMemoryManagerFactory
    {
        /// <summary>
        /// Creates a new <see cref="ICacheEntryMemoryManager"/> for the specified bucket
        /// identified by the given <paramref name="bucketId"/>
        /// </summary>
        /// <param name="bucketId">The unique id of a bucket within the table</param>
        /// <returns></returns>
        ICacheEntryMemoryManager CreateForBucket(uint bucketId);
    }
}