IAsyncReadFileHandle

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Async/AsyncFileHandle.h

Include

#include "Async/AsyncFileHandle.h"

Syntax

class IAsyncReadFileHandle

Constructors

Name Description

Public function

IAsyncReadFileHandle()

Public function

IAsyncReadFileHandle

(
    const IAsyncReadFileHandle&
)

Non-copyable.

Destructors

Name Description

Public function Virtual

~IAsyncReadFileHandle()

Destructor, also the only way to close the file handle.

Functions

Name Description

Public function

IAsyncReadRe...

 

ReadRequest

(
    int64 Offset,
    int64 BytesToRead,
    EAsyncIOPriorityAndFlags PriorityAn...,
    FAsyncFileCallBack* CompleteCa...,
    uint8* UserSuppliedMemory
)

Submit an async request and/or wait for an async request

Public function Virtual

void

 

ShrinkHandleBuffers()

Minimizes buffers held internally by this handle.

Public function

IAsyncReadRe...

 

SizeRequest

(
    FAsyncFileCallBack* CompleteCa...
)

Request the size of the file. This is also essentially the existence check.

Public function Virtual

bool

 

UsesCache()

Return true if this file is backed by a cache, if not, then precache requests are ignored.

Operators

Name Description

Public function

IAsyncReadFi...

 

operator=

(
    const IAsyncReadFileHandle&
)