IMappedFileRegion Class Reference

#include <MappedFileHandle.h>

Inheritance diagram for IMappedFileRegion:

Public Member Functions
	IMappedFileRegion (const uint8 *InMappedPtr, size_t InMappedSize, const FString &InDebugFilename, size_t InDebugOffsetRelativeToFile)
virtual	~IMappedFileRegion ()
const uint8 *	GetMappedPtr ()
int64	GetMappedSize ()
virtual void	PreloadHint (int64 PreloadOffset=0, int64 BytesToPreload=MAX_int64)
virtual void	Flush (int64 FlushOffset=0, int64 BytesToFlush=MAX_int64)
	IMappedFileRegion (const IMappedFileRegion &)=delete
IMappedFileRegion &	operator= (const IMappedFileRegion &)=delete

Constructor & Destructor Documentation

IMappedFileRegion() [1/2]

IMappedFileRegion::IMappedFileRegion ( const uint8 *  InMappedPtr, size_t  InMappedSize, const FString &  InDebugFilename, size_t  InDebugOffsetRelativeToFile  )

inline

~IMappedFileRegion()

virtual IMappedFileRegion::~IMappedFileRegion ( )

inlinevirtual

IMappedFileRegion() [2/2]

IMappedFileRegion::IMappedFileRegion ( const IMappedFileRegion &  )

delete

Member Function Documentation

Flush()

virtual void IMappedFileRegion::Flush ( int64  FlushOffset = 0, int64  BytesToFlush = MAX_int64  )

inlinevirtual

Synchronously flush part or all of the mapped region. This is only a hint, some platforms might ignore it. There are not guarantees how long this data will stay in paged out.

Parameters

FlushOffset	Offset into this region to flush
BytesToFlush	number of bytes to flush. This is clamped to the size of the mapped region

GetMappedPtr()

const uint8 * IMappedFileRegion::GetMappedPtr ( )

inline

Return the pointer to the mapped region.

Returns

Returned size of the file or -1 if the file was not found, the request was canceled or other error.

GetMappedSize()

int64 IMappedFileRegion::GetMappedSize ( )

inline

Return the size of the mapped region.

operator=()

IMappedFileRegion & IMappedFileRegion::operator= ( const IMappedFileRegion &  )

delete

PreloadHint()

virtual void IMappedFileRegion::PreloadHint ( int64  PreloadOffset = 0, int64  BytesToPreload = MAX_int64  )

inlinevirtual

Synchronously preload part or all of the mapped region. Typically this is done by reading a byte from each CPU page. This is only a hint, some platforms might ignore it. There are not guarantees how long this data will stay in memory.

Parameters

PreloadOffset	Offset into this region to preload
BytesToPreload	number of bytes to preload. This is clamped to the size of the mapped region

Reimplemented in FMappedFileRegion, FMappedFileRegionWindows, and FMappedRegionPakProxy.

---

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

• Engine/Source/Runtime/Core/Public/Async/MappedFileHandle.h