aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Data.Caching/src/IObjectData.cs
blob: e18de394f1198c65b8c286bbbe242119277005ee (plain)
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
42
43
44
45
46
/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Data.Caching
* File: IObjectData.cs 
*
* IObjectData.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;

namespace VNLib.Data.Caching
{
    /// <summary>
    /// Represents object data to send or receive from a cache server
    /// </summary>
    public interface IObjectData
    {
        /// <summary>
        /// Gets the cachable objects data to store in the remote cache server
        /// </summary>
        /// <returns>The object data to set</returns>
        ReadOnlySpan<byte> GetData();

        /// <summary>
        /// Stores the retrieved object data from the remote server
        /// </summary>
        /// <param name="data">The object data found on the remote server</param>
        void SetData(ReadOnlySpan<byte> data);
    }
}