UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | List of all members
UE::FPackageResourceIoBackend Class Referencefinal
+ Inheritance diagram for UE::FPackageResourceIoBackend:

Public Member Functions

 FPackageResourceIoBackend (IPackageResourceManager &Mgr)
 
 ~FPackageResourceIoBackend ()
 
virtual void Initialize (TSharedRef< const FIoDispatcherBackendContext > Context) override
 
virtual void ResolveIoRequests (FIoRequestList Requests, FIoRequestList &OutUnresolved) override
 
virtual void CancelIoRequest (FIoRequestImpl *Request) override
 
virtual void UpdatePriorityForIoRequest (FIoRequestImpl *Request) override
 
virtual bool DoesChunkExist (const FIoChunkId &ChunkId) const override
 
virtual TIoStatusOr< uint64 > GetSizeForChunk (const FIoChunkId &ChunkId) const override
 
virtual FIoRequestImpl * GetCompletedIoRequests () override
 
virtual TIoStatusOr< FIoMappedRegion > OpenMapped (const FIoChunkId &ChunkId, const FIoReadOptions &Options) override
 
virtual const TCHAR * GetName () const override
 
- Public Member Functions inherited from IIoDispatcherBackend
virtual void Shutdown ()
 
virtual bool DoesChunkExist (const FIoChunkId &ChunkId, const FIoOffsetAndLength &ChunkRange) const
 
virtual TIoStatusOr< uint64 > GetSizeForChunk (const FIoChunkId &ChunkId, const FIoOffsetAndLength &ChunkRange, uint64 &OutAvailable) const
 

Constructor & Destructor Documentation

◆ FPackageResourceIoBackend()

UE::FPackageResourceIoBackend::FPackageResourceIoBackend ( IPackageResourceManager &  Mgr)

◆ ~FPackageResourceIoBackend()

UE::FPackageResourceIoBackend::~FPackageResourceIoBackend ( )

Member Function Documentation

◆ CancelIoRequest()

void UE::FPackageResourceIoBackend::CancelIoRequest ( FIoRequestImpl *  Request)
overridevirtual

Cancel the I/O request.

Implements IIoDispatcherBackend.

◆ DoesChunkExist()

bool UE::FPackageResourceIoBackend::DoesChunkExist ( const FIoChunkId &  ChunkId) const
overridevirtual

Returns whether the chunk exists.

Implements IIoDispatcherBackend.

◆ GetCompletedIoRequests()

FIoRequestImpl * UE::FPackageResourceIoBackend::GetCompletedIoRequests ( )
overridevirtual

Returns all completed request(s) to the I/O dispatcher. Triggered by invoking the wake-up callback on the backend context object.

Implements IIoDispatcherBackend.

◆ GetName()

const TCHAR * UE::FPackageResourceIoBackend::GetName ( ) const
overridevirtual

Returns the name of this backend, for logging purposes

Implements IIoDispatcherBackend.

◆ GetSizeForChunk()

TIoStatusOr< uint64 > UE::FPackageResourceIoBackend::GetSizeForChunk ( const FIoChunkId &  ChunkId) const
overridevirtual

Returns the size of the chunk.

Implements IIoDispatcherBackend.

◆ Initialize()

void UE::FPackageResourceIoBackend::Initialize ( TSharedRef< const FIoDispatcherBackendContext >  Context)
overridevirtual

Called by the I/O dispatcher once initialized.

Parameters
ContextContext object used for signalling the I/O dispatcher.

Implements IIoDispatcherBackend.

◆ OpenMapped()

TIoStatusOr< FIoMappedRegion > UE::FPackageResourceIoBackend::OpenMapped ( const FIoChunkId &  ChunkId,
const FIoReadOptions &  Options 
)
overridevirtual

Read the chunk as a memory mapped file.

Implements IIoDispatcherBackend.

◆ ResolveIoRequests()

void UE::FPackageResourceIoBackend::ResolveIoRequests ( FIoRequestList  Requests,
FIoRequestList &  OutUnresolved 
)
overridevirtual

Create asynchronous read requests for the list of I/O request(s). The request(s) can span multiple chunks.

Parameters
RequestsRequest(s) to resolve.
OutUnresolvedUnresolved request(s) returned to the I/O dispatcher.

Implements IIoDispatcherBackend.

◆ UpdatePriorityForIoRequest()

virtual void UE::FPackageResourceIoBackend::UpdatePriorityForIoRequest ( FIoRequestImpl *  Request)
inlineoverridevirtual

Update the priority of the I/O request.

Implements IIoDispatcherBackend.

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