#include <DerivedData.h>

Public Member Functions
void	Reset ()

bool	IsNull () const

	operator bool () const

UE_API void	SetPriority (FDerivedDataIoPriority Priority)

UE_API bool	Cancel ()

UE_API bool	Poll () const

UE_API EDerivedDataIoStatus	GetOverallStatus () const

UE_API EDerivedDataIoStatus	GetStatus (FDerivedDataIoRequest Handle) const

UE_API FSharedBuffer	GetData (FDerivedDataIoRequest Handle) const

UE_API uint64	GetSize (FDerivedDataIoRequest Handle) const

Detailed Description

Tracks one or more associated requests dispatched by FDerivedDataIoBatch.

Any const member functions are thread-safe, while any non-const member functions are not.

Asserts that requests are complete upon destruction or assignment.

Member Function Documentation

◆ Cancel()

bool UE::FDerivedDataIoResponse::Cancel ( )

Cancels the associated requests if they are not complete.

Returns: true if cancellation completed synchronously, or false if further polling is needed.

◆ GetData()

FSharedBuffer UE::FDerivedDataIoResponse::GetData ( FDerivedDataIoRequest Handle ) const

Returns the data for the request. Null if executing, failed, or canceled.

◆ GetOverallStatus()

EDerivedDataIoStatus UE::FDerivedDataIoResponse::GetOverallStatus ( ) const

Returns the overall status of the requests. See EDerivedDataIoStatus.

The status of the overall response is, in priority order,

Unknown if any request status is Unknown, or
Canceled if any request status is Canceled, or
Error if any request status is Error, otherwise
Ok because every request status must be Ok.

◆ GetSize()

uint64 UE::FDerivedDataIoResponse::GetSize ( FDerivedDataIoRequest Handle ) const

Returns the size for the request. Zero if not available, executing, failed, or canceled.

◆ GetStatus()

EDerivedDataIoStatus UE::FDerivedDataIoResponse::GetStatus ( FDerivedDataIoRequest Handle ) const

Returns the status of the request. See EDerivedDataIoStatus.

◆ IsNull()

bool UE::FDerivedDataIoResponse::IsNull ( ) const

inline

Returns true if this is a null response .

◆ operator bool()

UE::FDerivedDataIoResponse::operator bool ( ) const

inlineexplicit

Returns true if this is a non-null response.

◆ Poll()

bool UE::FDerivedDataIoResponse::Poll ( ) const

Returns true if the associated requests are complete and the optional callback was invoked.

◆ Reset()

void UE::FDerivedDataIoResponse::Reset ( )

inline

Resets this to a null response. Asserts that requests are complete.

◆ SetPriority()

void UE::FDerivedDataIoResponse::SetPriority ( FDerivedDataIoPriority Priority )

Sets the priority of the associated requests if they are not complete.

The documentation for this class was generated from the following files:

Engine/Source/Runtime/CoreUObject/Public/Serialization/DerivedData.h
Engine/Source/Runtime/CoreUObject/Private/Serialization/DerivedData.cpp

Public Member Functions