UE::Virtualization::FPushRequest Struct Reference

#include <VirtualizationSystem.h>

Public Member Functions
	FPushRequest ()=delete
	~FPushRequest ()=default
	FPushRequest (const FIoHash &InIdentifier, const FCompressedBuffer &InPayload, const FString &InContext)
	FPushRequest (const FIoHash &InIdentifier, FCompressedBuffer &&InPayload, FString &&InContext)
	FPushRequest (const FIoHash &InIdentifier, IPayloadProvider &InProvider, FString &&InContext)
const FIoHash &	GetIdentifier () const
uint64	GetPayloadSize () const
FCompressedBuffer	GetPayload () const
const FString &	GetContext () const
void	ResetResult ()
void	SetResult (FPushResult InResult)
const FPushResult &	GetResult () const

Detailed Description

Data structure representing a request to push a payload to a backend storage system. Note that a request can either before for payload already in memory (in which case the payload should be passed into the constructor as a FCompressedBuffer) or by a IPayloadProvider which will provide the payload on demand.

Constructor & Destructor Documentation

FPushRequest() [1/4]

UE::Virtualization::FPushRequest::FPushRequest ( )

delete

~FPushRequest()

UE::Virtualization::FPushRequest::~FPushRequest ( )

default

FPushRequest() [2/4]

UE::Virtualization::FPushRequest::FPushRequest ( const FIoHash &  InIdentifier, const FCompressedBuffer &  InPayload, const FString &  InContext  )

inline

Create a request for a payload already in memory

Parameters

InIdentifier	The hash of the payload in its uncompressed form
InPayload	The payload, this can be in any compressed format that the caller wishes.
InContext	Content showing where the payload came from. If it comes from a package then this should be the package path

FPushRequest() [3/4]

UE::Virtualization::FPushRequest::FPushRequest ( const FIoHash &  InIdentifier, FCompressedBuffer &&  InPayload, FString &&  InContext  )

inline

Create a request for a payload already in memory

Parameters

InIdentifier	The hash of the payload in its uncompressed form
InPayload	The payload, this can be in any compressed format that the caller wishes.
InContext	Content showing where the payload came from. If it comes from a package then this should be the package path

FPushRequest() [4/4]

UE::Virtualization::FPushRequest::FPushRequest ( const FIoHash &  InIdentifier, IPayloadProvider &  InProvider, FString &&  InContext  )

inline

Create a request for a payload to be loaded on demand

Parameters

InIdentifier	The hash of the payload in its uncompressed form
InProvider	The provider that will load the payload when requested. The providers lifespan must exceed that of the FPushRequest
InContext	Content showing where the payload came from. If it comes from a package then this should be the package path

Member Function Documentation

GetContext()

const FString & UE::Virtualization::FPushRequest::GetContext ( ) const

inline

Returns the context of the payload

GetIdentifier()

const FIoHash & UE::Virtualization::FPushRequest::GetIdentifier ( ) const

inline

Return the identifer used in the request

GetPayload()

FCompressedBuffer UE::Virtualization::FPushRequest::GetPayload ( ) const

inline

Returns the payload

GetPayloadSize()

uint64 UE::Virtualization::FPushRequest::GetPayloadSize ( ) const

inline

Returns the size of the payload when it was on disk

GetResult()

const FPushResult & UE::Virtualization::FPushRequest::GetResult ( ) const

inline

ResetResult()

void UE::Virtualization::FPushRequest::ResetResult ( )

inline

SetResult()

void UE::Virtualization::FPushRequest::SetResult ( FPushResult  InResult )

inline

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h