UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FIoRequestImpl Class Referenceabstract

#include <IoDispatcherBackend.h>

+ Inheritance diagram for FIoRequestImpl:

Public Member Functions

 TSAN_ATOMIC (int32) Priority=0
 
 FIoRequestImpl (class FIoRequestAllocator &InAllocator)
 
bool IsCancelled () const
 
bool IsFailed () const
 
void SetFailed ()
 
void SetLastBackendError (EIoErrorCode InError)
 
bool HasBuffer () const
 
CORE_API void CreateBuffer (uint64 Size)
 
FIoBufferGetBuffer ()
 
void SetResult (FIoBuffer InBuffer)
 
uint64 GetStartTime () const
 

Public Attributes

FIoRequestImplNextRequest = nullptr
 
voidBackendData = nullptr
 
FIoChunkId ChunkId
 
FIoReadOptions Options
 

Friends

class FIoDispatcherImpl
 
class FIoRequest
 
class FIoBatch
 
class FIoRequestStats
 

Detailed Description

I/O request object.

Constructor & Destructor Documentation

◆ FIoRequestImpl()

FIoRequestImpl::FIoRequestImpl ( class FIoRequestAllocator InAllocator)
inline

Member Function Documentation

◆ CreateBuffer()

void FIoRequestImpl::CreateBuffer ( uint64  Size)

Creates a new buffer for the request.

◆ GetBuffer()

FIoBuffer & FIoRequestImpl::GetBuffer ( )
inline

Returns the internal buffer.

◆ GetStartTime()

uint64 FIoRequestImpl::GetStartTime ( ) const
inline

◆ HasBuffer()

bool FIoRequestImpl::HasBuffer ( ) const
inline

Returns whether request has a valid buffer.

◆ IsCancelled()

bool FIoRequestImpl::IsCancelled ( ) const
inline

Returns whether the request has been cancelled.

◆ IsFailed()

bool FIoRequestImpl::IsFailed ( ) const
inline

Returns whether the request failed.

◆ SetFailed()

void FIoRequestImpl::SetFailed ( )
inline

Mark the request as failed (EIoErrorCode::ReadError).

◆ SetLastBackendError()

void FIoRequestImpl::SetLastBackendError ( EIoErrorCode  InError)
inline

◆ SetResult()

void FIoRequestImpl::SetResult ( FIoBuffer  InBuffer)
inline

Sets a new buffer.

◆ TSAN_ATOMIC()

FIoRequestImpl::TSAN_ATOMIC ( int32  )
pure virtual

I/O dispatcher priority (EIoDispatcherPriority).

Friends And Related Symbol Documentation

◆ FIoBatch

friend class FIoBatch
friend

◆ FIoDispatcherImpl

friend class FIoDispatcherImpl
friend

◆ FIoRequest

friend class FIoRequest
friend

◆ FIoRequestStats

friend class FIoRequestStats
friend

Member Data Documentation

◆ BackendData

void* FIoRequestImpl::BackendData = nullptr

Custom data that can be used freely by the I/O dispatcher backend(s).

◆ ChunkId

FIoChunkId FIoRequestImpl::ChunkId

The chunk ID.

◆ NextRequest

FIoRequestImpl* FIoRequestImpl::NextRequest = nullptr

Pointer to the next request that can be used freely by the I/O dispatcher backend(s).

◆ Options

FIoReadOptions FIoRequestImpl::Options

Read options.


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