FPushRequest | Unreal Engine 5.6 Documentation

API > API/Runtime > API/Runtime/Core

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.


Name	FPushRequest
Type	struct
Header File	/Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h
Include Path	#include "Virtualization/VirtualizationSystem.h"

Syntax

struct FPushRequest

Constructors

Name	Remarks	Include Path
FPushRequest ()		Virtualization/VirtualizationSystem.h
FPushRequest ( const FIoHash& InIdentifier, const FCompressedBuffer& InPayload, const FString& InContext )	Create a request for a payload already in memory	Virtualization/VirtualizationSystem.h
FPushRequest ( const FIoHash& InIdentifier, FCompressedBuffer&& InPayload, FString&& InContext )	Create a request for a payload already in memory	Virtualization/VirtualizationSystem.h
FPushRequest ( const FIoHash& InIdentifier, IPayloadProvider& InProvider, FString&& InContext )	Create a request for a payload to be loaded on demand	Virtualization/VirtualizationSystem.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FPushRequest()		Virtualization/VirtualizationSystem.h

Variables

Protected

Name	Type	Remarks	Include Path
Context	FString	A string containing context for the payload, typically a package name	Virtualization/VirtualizationSystem.h
Identifier	FIoHash	The identifier of the payload	Virtualization/VirtualizationSystem.h
Payload	FCompressedBuffer	The payload data	Virtualization/VirtualizationSystem.h
Provider	IPayloadProvider *	Provider to retrieve the payload from	Virtualization/VirtualizationSystem.h
Result	FPushResult		Virtualization/VirtualizationSystem.h

Functions

Public

Name	Remarks	Include Path
const FString & GetContext()	Returns the context of the payload	Virtualization/VirtualizationSystem.h
const FIoHash & GetIdentifier()	Return the identifer used in the request	Virtualization/VirtualizationSystem.h
FCompressedBuffer GetPayload()	Returns the payload	Virtualization/VirtualizationSystem.h
uint64 GetPayloadSize()	Returns the size of the payload when it was on disk	Virtualization/VirtualizationSystem.h
const FPushResult & GetResult()		Virtualization/VirtualizationSystem.h
void ResetResult()		Virtualization/VirtualizationSystem.h
void SetResult ( FPushResult InResult )		Virtualization/VirtualizationSystem.h

Navigation