You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
f4e06ebd3a
#rb Per.Larsson #rnx #preflight 61a8940b9c77d610079ce7da - Made all backends final, they should not be derived from. - Added header files for the remaining backends that were cpp only. The headers are in the modules private directory so will not be used elsewhere and it makes it easier to see the interface. #ROBOMERGE-AUTHOR: paul.chipchase #ROBOMERGE-SOURCE: CL 18350848 in //UE5/Release-5.0/... via CL 18350854 #ROBOMERGE-BOT: STARSHIP (Release-Engine-Staging -> Release-Engine-Test) (v895-18170469) [CL 18350856 by paul chipchase in ue5-release-engine-test branch]
92 lines
3.4 KiB
C++
92 lines
3.4 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "IVirtualizationBackend.h"
|
|
|
|
namespace UE::Utility { struct FRequestPool; }
|
|
namespace UE::Utility { struct FAccessToken; }
|
|
|
|
namespace UE::Virtualization
|
|
{
|
|
/**
|
|
* This backend allows data to be stored in and retrieved from a Jupiter service.
|
|
*
|
|
* Ini file setup:
|
|
* 'Name'=(Type=Jupiter, Host="", Namespace="", ChunkSize=, OAuthProvider="", OAuthClientId="", OAuthSecret="")
|
|
* Host: The URL of the service, use http://localhost if hosted locally.
|
|
* Namespace: Jupiter storage is divided into a number of namespaces allowing projects to keep their data separate
|
|
* while using the same service. This value controls which name space will be used.
|
|
* ChunkSize: Each payload can be divided into a number of chunks when being uploaded to Jupiter to improve upload
|
|
* performance, this value sets the max size (in bytes) of each chunk. To disable and attempt to upload
|
|
* each payload as a single data blob, set this to -1.
|
|
* OAuthProvider: Url of the OAuth authorization server.
|
|
* OAuthClientId: Public identifier for use with the OAuth authorization server.
|
|
* OAuthSecret: Password for the OAuthClientId
|
|
* (Note that the OAuth entries are not required if hosting locally)
|
|
*/
|
|
class FJupiterBackend final : public IVirtualizationBackend
|
|
{
|
|
public:
|
|
explicit FJupiterBackend(FStringView ConfigName, FStringView DebugName);
|
|
virtual ~FJupiterBackend() = default;
|
|
|
|
private:
|
|
/* IVirtualizationBackend implementation */
|
|
|
|
virtual bool Initialize(const FString& ConfigEntry) override;
|
|
|
|
virtual EPushResult PushData(const FPayloadId& Id, const FCompressedBuffer& CompressedPayload, const FPackagePath& PackageContext) override;
|
|
|
|
virtual FCompressedBuffer PullData(const FPayloadId& Id) override;
|
|
|
|
virtual bool DoesPayloadExist(const FPayloadId& Id) override;
|
|
|
|
private:
|
|
|
|
bool IsUsingLocalHost() const;
|
|
bool IsServiceReady() const;
|
|
bool AcquireAccessToken();
|
|
|
|
/**
|
|
* Request the status of the service that we are connected to and make sure that it supports the
|
|
* feature set we need and meets our minimum version requirements.
|
|
*/
|
|
bool ValidateServiceVersion();
|
|
|
|
bool ShouldRetryOnError(int64 ResponseCode);
|
|
|
|
bool PostChunk(const TArrayView<const uint8>& ChunkData, const FPayloadId& PayloadId, FString& OutHashAsString);
|
|
bool PullChunk(const FString& Hash, const FPayloadId& PayloadId, uint8* DataPtr, int64 BufferSize);
|
|
bool DoesChunkExist(const FString& Hash);
|
|
|
|
/** Address of the Jupiter service*/
|
|
FString HostAddress;
|
|
/** Namespace to connect to */
|
|
FString Namespace;
|
|
/** Europa allows us to organize the payloads by bucket. Currently this is not exposed and just set to 'default' */
|
|
FString Bucket;
|
|
|
|
/** The max size of each payload chunk */
|
|
uint64 ChunkSize;
|
|
|
|
/** Url of the OAuth authorization server */
|
|
FString OAuthProvider;
|
|
/** Public identifier for use with the OAuth authorization server */
|
|
FString OAuthClientId;
|
|
/** Password for the OAuthClientId */
|
|
FString OAuthSecret;
|
|
|
|
/** The pool of FRequest objects that can be recycled */
|
|
TUniquePtr<Utility::FRequestPool> RequestPool;
|
|
|
|
/** Critical section used to protect the creation of new access tokens */
|
|
FCriticalSection AccessCs;
|
|
/** The access token used with service authorization */
|
|
TUniquePtr<Utility::FAccessToken> AccessToken;
|
|
/** Count how many times a login has failed since the last successful login */
|
|
uint32 FailedLoginAttempts;
|
|
};
|
|
|
|
} // namespace UE::Virtualization
|