aboutsummaryrefslogtreecommitdiff
path: root/zenserver/upstream/upstreamcache.h
blob: d8359bc2c8764d9707720dcb99896889de254512 (plain) (blame)
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include <zencore/iobuffer.h>
#include <zencore/iohash.h>
#include <zencore/zencore.h>

#include <memory>

class ZenCacheStore;

namespace zen {

class CidStore;
struct CloudCacheClientOptions;

struct UpstreamCacheKey
{
	std::string Bucket;
	IoHash		Hash;
};

struct UpstreamPayloadKey
{
	UpstreamCacheKey CacheKey;
	IoHash			 PayloadId;
};

struct UpstreamCacheRecord
{
	ZenContentType		Type = ZenContentType::kBinary;
	UpstreamCacheKey	CacheKey;
	std::vector<IoHash> PayloadIds;
};

struct UpstreamCacheOptions
{
	uint32_t ThreadCount = 4;
};

struct GetUpstreamCacheResult
{
	IoBuffer	Value;
	std::string Reason;
	bool		Success = false;
};

struct PutUpstreamCacheResult
{
	std::string Reason;
	bool		Success;
};

/**
 * The upstream endpont is responsible for handling upload/downloading of cache records.
 */
class UpstreamEndpoint
{
public:
	virtual ~UpstreamEndpoint() = default;

	virtual bool Initialize() = 0;

	virtual std::string_view DisplayName() const = 0;

	virtual GetUpstreamCacheResult GetCacheRecord(UpstreamCacheKey CacheKey, ZenContentType Type) = 0;

	virtual GetUpstreamCacheResult GetCachePayload(UpstreamPayloadKey PayloadKey) = 0;

	virtual PutUpstreamCacheResult PutCacheRecord(const UpstreamCacheRecord& CacheRecord,
												  IoBuffer					 RecordValue,
												  std::span<IoBuffer const>	 Payloads) = 0;
};

/**
 * Manages one or more upstream cache endpoints.
 */
class UpstreamCache
{
public:
	virtual ~UpstreamCache() = default;

	virtual bool Initialize() = 0;

	virtual void AddEndpoint(std::unique_ptr<UpstreamEndpoint> Endpoint) = 0;

	virtual GetUpstreamCacheResult GetCacheRecord(UpstreamCacheKey CacheKey, ZenContentType Type) = 0;

	virtual GetUpstreamCacheResult GetCachePayload(UpstreamPayloadKey PayloadKey) = 0;

	struct EnqueueResult
	{
		bool Success = false;
	};

	virtual EnqueueResult EnqueueUpstream(UpstreamCacheRecord CacheRecord) = 0;
};

std::unique_ptr<UpstreamCache> MakeUpstreamCache(const UpstreamCacheOptions& Options, ::ZenCacheStore& CacheStore, CidStore& CidStore);

std::unique_ptr<UpstreamEndpoint> MakeJupiterUpstreamEndpoint(const CloudCacheClientOptions& Options);

std::unique_ptr<UpstreamEndpoint> MakeZenUpstreamEndpoint(std::string_view Url);

}  // namespace zen