aboutsummaryrefslogtreecommitdiff
path: root/zenserver/upstream/upstreamcache.h
blob: 23a5421519b93328d8a1bf3cb46630e1bcac96f4 (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
// 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 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;
	bool			 JupiterEnabled = true;
	std::string_view JupiterEndpoint;
	std::string_view JupiterDdcNamespace;
	std::string_view JupiterBlobStoreNamespace;
	std::string_view JupiterOAuthProvider;
	std::string_view JupiterOAuthClientId;
	std::string_view JupiterOAuthSecret;
};

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

	struct GetCacheRecordResult
	{
		IoBuffer Value;
		bool	 Success = false;
	};

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

	struct GetCachePayloadResult
	{
		IoBuffer Payload;
		bool	 Success = false;
	};

	virtual GetCachePayloadResult 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);

}  // namespace zen