IFileCacheHandle

All methods may be safely called from multiple threads simultaneously, unless otherwise noted

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/FileCache/FileCache.h

Include

#include "FileCache/FileCache.h"

Syntax

class IFileCacheHandle

Remarks

All methods may be safely called from multiple threads simultaneously, unless otherwise noted

Also note, if you create several IFileCacheHandle's to the same file on separate threads these will be considered as individual separate files from the cache point of view and thus each will have their own cache data allocated.

Destructors

Name Description

Public function Virtual

~IFileCacheHandle()

Functions

Name Description

Public function Static

IFileCacheHa...

 

CreateFileCacheHandle

(
    const TCHAR* InFileName,
    int64 InBaseOffset
)

Create a IFileCacheHandle from a filename.

Public function Static

IFileCacheHa...

 

CreateFileCacheHandle

(
    IAsyncReadFileHandle* FileHand...,
    int64 InBaseOffset
)

Create a IFileCacheHandle from a IAsyncReadFileHandle.

Public function Static

void

 

EvictAll()

Public function Static

int64

 

GetFileCacheSize()

Return size of underlying file cache in bytes.

Public function

FGraphEventR...

 

PreloadData

(
    const FFileCachePreloadEntry* ...,
    int32 NumEntries,
    EAsyncIOPriorityAndFlags Priority
)

Public function

IMemoryReadS...

 

ReadData

(
    FGraphEventArray& OutCompletionEve...,
    int64 Offset,
    int64 BytesToRead,
    EAsyncIOPriorityAndFlags Priority
)

Read a byte range form the file.

Public function

void

 

WaitAll()

Wait until all outstanding read requests complete.