UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FIoDispatcher Class Referencefinal

#include <IoDispatcher.h>

Public Member Functions

 DECLARE_EVENT_OneParam (FIoDispatcher, FIoContainerMountedEvent, const FIoDispatcherMountedContainer &)
 
 DECLARE_EVENT_OneParam (FIoDispatcher, FIoContainerUnmountedEvent, const FIoDispatcherMountedContainer &)
 
CORE_API FIoDispatcher ()
 
CORE_API ~FIoDispatcher ()
 
CORE_API void Mount (TSharedRef< IIoDispatcherBackend > Backend, int32 Priority=0)
 
CORE_API FIoBatch NewBatch ()
 
CORE_API TIoStatusOr< FIoMappedRegionOpenMapped (const FIoChunkId &ChunkId, const FIoReadOptions &Options)
 
CORE_API bool DoesChunkExist (const FIoChunkId &ChunkId) const
 
CORE_API TIoStatusOr< uint64GetSizeForChunk (const FIoChunkId &ChunkId) const
 
CORE_API int64 GetTotalLoaded () const
 
CORE_API FIoSignatureErrorDelegateOnSignatureError ()
 
 FIoDispatcher (const FIoDispatcher &)=default
 
FIoDispatcheroperator= (const FIoDispatcher &)=delete
 

Static Public Member Functions

static CORE_API bool IsInitialized ()
 
static CORE_API FIoStatus Initialize ()
 
static CORE_API void InitializePostSettings ()
 
static CORE_API void Shutdown ()
 
static CORE_API FIoDispatcherGet ()
 

Friends

class FIoRequest
 
class FIoBatch
 
class FIoQueue
 
class FBulkData
 

Detailed Description

I/O dispatcher

Constructor & Destructor Documentation

◆ FIoDispatcher() [1/2]

FIoDispatcher::FIoDispatcher ( )

◆ ~FIoDispatcher()

FIoDispatcher::~FIoDispatcher ( )

◆ FIoDispatcher() [2/2]

FIoDispatcher::FIoDispatcher ( const FIoDispatcher )
default

Member Function Documentation

◆ DECLARE_EVENT_OneParam() [1/2]

FIoDispatcher::DECLARE_EVENT_OneParam ( FIoDispatcher  ,
FIoContainerMountedEvent  ,
const FIoDispatcherMountedContainer  
)

◆ DECLARE_EVENT_OneParam() [2/2]

FIoDispatcher::DECLARE_EVENT_OneParam ( FIoDispatcher  ,
FIoContainerUnmountedEvent  ,
const FIoDispatcherMountedContainer  
)

◆ DoesChunkExist()

bool FIoDispatcher::DoesChunkExist ( const FIoChunkId ChunkId) const

◆ Get()

FIoDispatcher & FIoDispatcher::Get ( )
static

◆ GetSizeForChunk()

TIoStatusOr< uint64 > FIoDispatcher::GetSizeForChunk ( const FIoChunkId ChunkId) const

◆ GetTotalLoaded()

int64 FIoDispatcher::GetTotalLoaded ( ) const

◆ Initialize()

FIoStatus FIoDispatcher::Initialize ( )
static

◆ InitializePostSettings()

void FIoDispatcher::InitializePostSettings ( )
static

◆ IsInitialized()

bool FIoDispatcher::IsInitialized ( )
static

◆ Mount()

void FIoDispatcher::Mount ( TSharedRef< IIoDispatcherBackend Backend,
int32  Priority = 0 
)

◆ NewBatch()

FIoBatch FIoDispatcher::NewBatch ( )

◆ OnSignatureError()

FIoSignatureErrorDelegate & FIoDispatcher::OnSignatureError ( )

◆ OpenMapped()

TIoStatusOr< FIoMappedRegion > FIoDispatcher::OpenMapped ( const FIoChunkId ChunkId,
const FIoReadOptions Options 
)

◆ operator=()

FIoDispatcher & FIoDispatcher::operator= ( const FIoDispatcher )
delete

◆ Shutdown()

void FIoDispatcher::Shutdown ( )
static

Friends And Related Symbol Documentation

◆ FBulkData

friend class FBulkData
friend

◆ FIoBatch

friend class FIoBatch
friend

◆ FIoQueue

friend class FIoQueue
friend

◆ FIoRequest

friend class FIoRequest
friend

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