UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::IoStore::FHttpIoDispatcherBackend Class Reference
+ Inheritance diagram for UE::IoStore::FHttpIoDispatcherBackend:

Public Member Functions

 FHttpIoDispatcherBackend (FOnDemandIoStore &IoStore)
 
virtual void SetOptionalBulkDataEnabled (bool bEnabled) override
 
virtual void ReportAnalytics (TArray< FAnalyticsEventAttribute > &OutAnalyticsArray) const override
 
virtual void Initialize (TSharedRef< const FIoDispatcherBackendContext > Context) override
 
virtual void Shutdown () override
 
virtual void ResolveIoRequests (FIoRequestList Requests, FIoRequestList &OutUnresolved) override
 
virtual FIoRequestImplGetCompletedIoRequests () override
 
virtual void CancelIoRequest (FIoRequestImpl *Request) override
 
virtual void UpdatePriorityForIoRequest (FIoRequestImpl *Request) override
 
virtual bool DoesChunkExist (const FIoChunkId &ChunkId) const override
 
virtual bool DoesChunkExist (const FIoChunkId &ChunkId, const FIoOffsetAndLength &ChunkRange) const override
 
virtual TIoStatusOr< uint64GetSizeForChunk (const FIoChunkId &ChunkId) const override
 
virtual TIoStatusOr< FIoMappedRegionOpenMapped (const FIoChunkId &ChunkId, const FIoReadOptions &Options) override
 
virtual const TCHARGetName () const
 
- Public Member Functions inherited from UE::IoStore::IOnDemandHttpIoDispatcherBackend
virtual ~IOnDemandHttpIoDispatcherBackend ()=default
 
- Public Member Functions inherited from IIoDispatcherBackend
virtual TIoStatusOr< uint64GetSizeForChunk (const FIoChunkId &ChunkId, const FIoOffsetAndLength &ChunkRange, uint64 &OutAvailable) const
 

Constructor & Destructor Documentation

◆ FHttpIoDispatcherBackend()

UE::IoStore::FHttpIoDispatcherBackend::FHttpIoDispatcherBackend ( FOnDemandIoStore IoStore)

Member Function Documentation

◆ CancelIoRequest()

void UE::IoStore::FHttpIoDispatcherBackend::CancelIoRequest ( FIoRequestImpl Request)
overridevirtual

Cancel the I/O request.

Implements IIoDispatcherBackend.

◆ DoesChunkExist() [1/2]

bool UE::IoStore::FHttpIoDispatcherBackend::DoesChunkExist ( const FIoChunkId ChunkId) const
overridevirtual

Returns whether the chunk exists.

Implements IIoDispatcherBackend.

◆ DoesChunkExist() [2/2]

bool UE::IoStore::FHttpIoDispatcherBackend::DoesChunkExist ( const FIoChunkId ChunkId,
const FIoOffsetAndLength ChunkRange 
) const
overridevirtual

Returns whether specified range of the chunk exists.

Reimplemented from IIoDispatcherBackend.

◆ GetCompletedIoRequests()

FIoRequestImpl * UE::IoStore::FHttpIoDispatcherBackend::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()

virtual const TCHAR * UE::IoStore::FHttpIoDispatcherBackend::GetName ( ) const
inlinevirtual

Returns the name of this backend, for logging purposes

Implements IIoDispatcherBackend.

◆ GetSizeForChunk()

TIoStatusOr< uint64 > UE::IoStore::FHttpIoDispatcherBackend::GetSizeForChunk ( const FIoChunkId ChunkId) const
overridevirtual

Returns the size of the chunk.

Implements IIoDispatcherBackend.

◆ Initialize()

void UE::IoStore::FHttpIoDispatcherBackend::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()

virtual TIoStatusOr< FIoMappedRegion > UE::IoStore::FHttpIoDispatcherBackend::OpenMapped ( const FIoChunkId ChunkId,
const FIoReadOptions Options 
)
inlineoverridevirtual

Read the chunk as a memory mapped file.

Implements IIoDispatcherBackend.

◆ ReportAnalytics()

void UE::IoStore::FHttpIoDispatcherBackend::ReportAnalytics ( TArray< FAnalyticsEventAttribute > &  OutAnalyticsArray) const
overridevirtual

◆ ResolveIoRequests()

void UE::IoStore::FHttpIoDispatcherBackend::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.

◆ SetOptionalBulkDataEnabled()

void UE::IoStore::FHttpIoDispatcherBackend::SetOptionalBulkDataEnabled ( bool  bEnabled)
overridevirtual

◆ Shutdown()

void UE::IoStore::FHttpIoDispatcherBackend::Shutdown ( )
overridevirtual

Called by the I/O dispatcher when shutting down.

Reimplemented from IIoDispatcherBackend.

◆ UpdatePriorityForIoRequest()

void UE::IoStore::FHttpIoDispatcherBackend::UpdatePriorityForIoRequest ( FIoRequestImpl Request)
overridevirtual

Update the priority of the I/O request.

Implements IIoDispatcherBackend.


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