#include <PreloadableFile.h>

Inheritance diagram for FPreloadableFile:

Public Member Functions
CORE_API	FPreloadableFile (FStringView FileName)

CORE_API void	InitializeAsync (uint32 InFlags=Flags::None, int64 PrimeSize=DefaultPrimeSize)

Public Member Functions inherited from FPreloadableArchive
CORE_API	FPreloadableArchive (FStringView ArchiveName)

virtual CORE_API	~FPreloadableArchive ()

CORE_API void	SetPageSize (int64 PageSize)

CORE_API void	InitializeAsync (FCreateArchive &&InCreateArchiveFunction, uint32 InFlags=Flags::None, int64 PrimeSize=DefaultPrimeSize)

CORE_API void	InitializeAsync (FCreateAsyncArchive &&InCreateAsyncArchiveFunction, uint32 InFlags=Flags::None, int64 PrimeSize=DefaultPrimeSize)

CORE_API bool	IsInitialized () const

CORE_API void	WaitForInitialization () const

CORE_API bool	StartPreload ()

CORE_API void	StopPreload ()

CORE_API bool	IsPreloading () const

CORE_API bool	AllocateCache ()

CORE_API void	ReleaseCache ()

CORE_API bool	IsCacheAllocated () const

CORE_API FArchive *	DetachLowerLevel ()

CORE_API bool	HasValidData () const

virtual CORE_API void	Serialize (void *V, int64 Length) final

virtual CORE_API void	Seek (int64 InPos) final

virtual CORE_API int64	Tell () final

virtual CORE_API int64	TotalSize () final

virtual CORE_API bool	Close () final

virtual CORE_API FString	GetArchiveName () const final

Public Member Functions inherited from FArchive
	FArchive ()=default

	FArchive (const FArchive &)=default

FArchive &	operator= (const FArchive &ArchiveToCopy)=default

virtual CORE_API	~FArchive ()

virtual FArchive &	operator<< (FName &Value)

virtual CORE_API FArchive &	operator<< (FText &Value)

virtual FArchive &	operator<< (UObject *&Value)

virtual FArchive &	operator<< (FField *&Value)

template<class T >
FArchive &	operator<< (TCheckedObjPtr< T > &Value)

virtual CORE_API FArchive &	operator<< (struct FLazyObjectPtr &Value)

virtual CORE_API FArchive &	operator<< (struct FObjectPtr &Value)

virtual CORE_API FArchive &	operator<< (struct FSoftObjectPtr &Value)

virtual CORE_API FArchive &	operator<< (struct FSoftObjectPath &Value)

virtual CORE_API FArchive &	operator<< (struct FWeakObjectPtr &Value)

virtual void	ForceBlueprintFinalization ()

virtual void	SerializeBits (void *V, int64 LengthBits)

virtual void	SerializeInt (uint32 &Value, uint32 Max)

virtual CORE_API void	SerializeIntPacked (uint32 &Value)

virtual CORE_API void	SerializeIntPacked64 (uint64 &Value)

virtual void	Preload (UObject *Object)

FArchiveState &	GetArchiveState ()

const FArchiveState &	GetArchiveState () const

virtual void	AttachBulkData (UObject Owner, FBulkData BulkData)

virtual void	AttachBulkData (UE::Serialization::FEditorBulkData *BulkData)

virtual void	DetachBulkData (FBulkData *BulkData, bool bEnsureBulkDataIsLoaded)

virtual void	DetachBulkData (UE::Serialization::FEditorBulkData *BulkData, bool bEnsureBulkDataIsLoaded)

virtual bool	SerializeBulkData (FBulkData &BulkData, const FBulkDataSerializationParams &Params)

virtual bool	IsProxyOf (FArchive *InOther) const

virtual bool	Precache (int64 PrecacheOffset, int64 PrecacheSize)

virtual void	FlushCache ()

virtual bool	SetCompressionMap (TArray< FCompressedChunk > *CompressedChunks, ECompressionFlags CompressionFlags)

virtual void	Flush ()

CORE_API void	SerializeCompressed (void *V, int64 Length, FName CompressionFormatCannotChange, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false)

CORE_API void	SerializeCompressedNew (void V, int64 Length, FName CompressionFormatToEncode, FName CompressionFormatToDecodeOldV1Files, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false, int64 OutPartialReadLength=nullptr)

CORE_API void	SerializeCompressedNew (void *V, int64 Length)

CORE_API void	ByteSwap (void *V, int32 Length)

FArchive &	ByteOrderSerialize (void *V, int32 Length)

void	StartSerializingDefaults ()

void	StopSerializingDefaults ()

virtual void	MarkScriptSerializationStart (const UObject *Obj)

virtual void	MarkScriptSerializationEnd (const UObject *Obj)

virtual void	MarkSearchableName (const TObjectPtr< const UObject > &TypeObject, const FName &ValueName) const

template<typename FmtType , typename... Types>
void	Logf (const FmtType &Fmt, Types... Args)

virtual CORE_API void	UsingCustomVersion (const struct FGuid &Guid)

virtual FArchive *	GetCacheableArchive ()

void	SetCookData (FArchiveCookData *InCookData)

FArchiveCookData *	GetCookData ()

virtual CORE_API void	PushSerializedProperty (class FProperty *InProperty, const bool bIsEditorOnlyProperty)

virtual CORE_API void	PopSerializedProperty (class FProperty *InProperty, const bool bIsEditorOnlyProperty)

virtual bool	AttachExternalReadDependency (FExternalReadCallback &ReadCallback)

template<SIZE_T Size>
bool	FastPathLoad (void *InDest)

virtual void	PushFileRegionType (EFileRegionType Type)

virtual void	PopFileRegionType ()

CORE_API void	SetArchiveState (const FArchiveState &InState)

CORE_API void	SetError ()

CORE_API void	ClearError ()

CORE_API void	SetCriticalError ()

virtual FArchiveState &	GetInnermostState ()

virtual void	CountBytes (SIZE_T InNum, SIZE_T InMax)

virtual FLinker *	GetLinker ()

virtual bool	AtEnd ()

bool	IsByteSwapping ()

void	ThisContainsCode ()

void	ThisContainsMap ()

CORE_API void	ThisRequiresLocalizationGather ()

virtual UObject *	GetArchetypeFromLoader (const UObject *Obj)

UE_FORCEINLINE_HINT FPackageFileVersion	UEVer () const

UE_FORCEINLINE_HINT int32	LicenseeUEVer () const

UE_FORCEINLINE_HINT FEngineVersionBase	EngineVer () const

virtual CORE_API uint32	EngineNetVer () const

virtual CORE_API uint32	GameNetVer () const

CORE_API int32	CustomVer (const struct FGuid &Key) const

UE_FORCEINLINE_HINT bool	IsLoading () const

UE_FORCEINLINE_HINT bool	IsLoadingFromCookedPackage () const

UE_FORCEINLINE_HINT bool	IsSaving () const

bool	IsTransacting () const

UE_FORCEINLINE_HINT bool	IsTextFormat () const

UE_FORCEINLINE_HINT bool	WantBinaryPropertySerialization () const

UE_FORCEINLINE_HINT bool	UseUnversionedPropertySerialization () const

UE_FORCEINLINE_HINT bool	IsForcingUnicode () const

UE_FORCEINLINE_HINT bool	IsPersistent () const

UE_FORCEINLINE_HINT bool	GetError () const

UE_FORCEINLINE_HINT bool	IsError () const

UE_FORCEINLINE_HINT bool	IsCriticalError () const

UE_FORCEINLINE_HINT bool	ContainsCode () const

UE_FORCEINLINE_HINT bool	ContainsMap () const

bool	RequiresLocalizationGather () const

UE_FORCEINLINE_HINT bool	ForceByteSwapping () const

UE_FORCEINLINE_HINT bool	IsSerializingDefaults () const

UE_FORCEINLINE_HINT bool	IsIgnoringArchetypeRef () const

UE_FORCEINLINE_HINT bool	DoDelta () const

UE_FORCEINLINE_HINT bool	DoIntraPropertyDelta () const

UE_FORCEINLINE_HINT bool	IsIgnoringOuterRef () const

UE_FORCEINLINE_HINT bool	IsIgnoringClassGeneratedByRef () const

UE_FORCEINLINE_HINT bool	IsIgnoringClassRef () const

UE_FORCEINLINE_HINT bool	IsAllowingLazyLoading () const

UE_FORCEINLINE_HINT bool	IsObjectReferenceCollector () const

UE_FORCEINLINE_HINT bool	IsModifyingWeakAndStrongReferences () const

UE_FORCEINLINE_HINT bool	IsCountingMemory () const

UE_FORCEINLINE_HINT uint32	GetPortFlags () const

UE_FORCEINLINE_HINT bool	HasAnyPortFlags (uint32 Flags) const

UE_FORCEINLINE_HINT bool	HasAllPortFlags (uint32 Flags) const

uint32	GetDebugSerializationFlags () const

UE_FORCEINLINE_HINT bool	ShouldSkipBulkData () const

UE_FORCEINLINE_HINT int64	GetMaxSerializeSize () const

virtual CORE_API const FCustomVersionContainer &	GetCustomVersions () const

virtual CORE_API void	SetCustomVersions (const FCustomVersionContainer &CustomVersionContainer)

virtual CORE_API void	ResetCustomVersions ()

CORE_API void	SetCustomVersion (const struct FGuid &Key, int32 Version, FName FriendlyName)

void	SetByteSwapping (bool Enabled)

void	SetPortFlags (uint32 InPortFlags)

virtual void	SetDebugSerializationFlags (uint32 InCustomFlags)

bool	IsFilterEditorOnly () const

virtual void	SetFilterEditorOnly (bool InFilterEditorOnly)

bool	IsSavingOptionalObject () const

virtual void	SetSavingOptionalObject (bool InSavingOptionalObject)

bool	IsSaveGame () const

UE_FORCEINLINE_HINT bool	IsNetArchive () const

UE_FORCEINLINE_HINT bool	IsCooking () const

UE_FORCEINLINE_HINT const ITargetPlatform *	CookingTarget () const

void	SetSavePackageData (FArchiveSavePackageData *InSavePackageData)

FArchiveSavePackageData *	GetSavePackageData ()

UE_FORCEINLINE_HINT FArchiveCookContext *	GetCookContext ()

virtual bool	UseToResolveEnumerators () const

virtual bool	ShouldSkipProperty (const FProperty *InProperty) const

virtual void	SetSerializedProperty (FProperty *InProperty)

UE_FORCEINLINE_HINT class FProperty *	GetSerializedProperty () const

CORE_API void	GetSerializedPropertyChain (TArray< class FProperty * > &OutProperties) const

UE_FORCEINLINE_HINT const FArchiveSerializedPropertyChain *	GetSerializedPropertyChain () const

virtual CORE_API void	SetSerializedPropertyChain (const FArchiveSerializedPropertyChain InSerializedPropertyChain, class FProperty InSerializedPropertyOverride=nullptr)

virtual void	SetSerializeContext (FUObjectSerializeContext *InLoadContext)

virtual CORE_API void	Reset ()

virtual CORE_API void	SetIsLoading (bool bInIsLoading)

virtual CORE_API void	SetIsLoadingFromCookedPackage (bool bInIsLoadingFromCookedPackage)

virtual CORE_API void	SetIsSaving (bool bInIsSaving)

virtual CORE_API void	SetIsTransacting (bool bInIsTransacting)

virtual CORE_API void	SetIsTextFormat (bool bInIsTextFormat)

virtual CORE_API void	SetWantBinaryPropertySerialization (bool bInWantBinaryPropertySerialization)

virtual CORE_API void	SetUseUnversionedPropertySerialization (bool bInUseUnversioned)

virtual CORE_API void	SetForceUnicode (bool bInForceUnicode)

virtual CORE_API void	SetIsPersistent (bool bInIsPersistent)

virtual CORE_API void	SetUEVer (FPackageFileVersion InVer)

virtual CORE_API void	SetLicenseeUEVer (int32 InVer)

virtual CORE_API void	SetEngineVer (const FEngineVersionBase &InVer)

virtual CORE_API void	SetEngineNetVer (const uint32 InEngineNetVer)

virtual CORE_API void	SetGameNetVer (const uint32 InGameNetVer)

UE_FORCEINLINE_HINT bool	ShouldSkipCompilingAssets () const

CORE_API void	SetShouldSkipUpdateCustomVersion (bool bShouldSkip)

UE_FORCEINLINE_HINT bool	ShouldSkipUpdateCustomVersion () const

CORE_API void	SetMigratingRemoteObjects (bool bMigrating)

UE_FORCEINLINE_HINT constexpr bool	IsMigratingRemoteObjects () const

virtual const FUObjectMigrationContext *	GetMigrationContext () const

Static Public Member Functions
static CORE_API bool	TryRegister (const TSharedPtr< FPreloadableFile > &PreloadableFile)

static CORE_API FArchive *	TryTakeArchive (const TCHAR *FileName)

static CORE_API bool	UnRegister (const TSharedPtr< FPreloadableFile > &PreloadableFile)

Additional Inherited Members
Public Types inherited from FPreloadableArchive
enum	Flags { None = 0x0 , ModeBits = 0x1 , PreloadHandle = 0x0 , PreloadBytes = 0x1 , Prime = 0x2 }

enum	{ DefaultPrimeSize = 1024 , DefaultPageSize = 64*1024 }

typedef TUniqueFunction< FArchive *()>	FCreateArchive

typedef TUniqueFunction< IAsyncReadFileHandle *()>	FCreateAsyncArchive

Public Attributes inherited from FArchive
FFastPathLoadBuffer *	ActiveFPLB

FFastPathLoadBuffer	InlineFPLB

uint8	ArContainsCode: 1

uint8	ArContainsMap: 1

UE_DEPRECATED(5.6, "Public access to ArRequiresLocalizationGather has been deprecated - please use Ar.RequiresLocalizationGather() and Ar.ThisRequiresLocalizationGather() for getting and setting respectively.") uint8 ArRequiresLocalizationGather uint8	ArForceByteSwapping: 1

uint8	ArIgnoreArchetypeRef: 1

uint8	ArNoDelta: 1

uint8	ArNoIntraPropertyDelta: 1

uint8	ArIgnoreOuterRef: 1

uint8	ArIgnoreClassGeneratedByRef: 1

uint8	ArIgnoreClassRef: 1

uint8	ArAllowLazyLoading: 1

uint8	ArIsObjectReferenceCollector: 1

uint8	ArIsModifyingWeakAndStrongReferences: 1

uint8	ArIsCountingMemory: 1

uint8	ArShouldSkipBulkData: 1

uint8	ArIsFilterEditorOnly: 1

uint8	ArIsSavingOptionalObject: 1

uint8	ArIsSaveGame: 1

uint8	ArIsNetArchive: 1

uint8	ArUseCustomPropertyList: 1

int32	ArSerializingDefaults

uint32	ArPortFlags

int64	ArMaxSerializeSize

uint8	ArMergeOverrides: 1

uint8	ArPreserveArrayElements: 1

const struct FCustomPropertyListNode *	ArCustomPropertyList

Protected Member Functions inherited from FPreloadableArchive
CORE_API void	InitializeInternalAsync (FCreateArchive &&InCreateArchiveFunction, FCreateAsyncArchive &&InCreateAsyncArchiveFunction, uint32 InFlags, int64 PrimeSize)

CORE_API void	InitializeInternal (FCreateArchive &&InCreateArchiveFunction, FCreateAsyncArchive &&InCreateAsyncArchiveFunction, uint32 Flags, int64 PrimeSize)

CORE_API void	PausePreload ()

CORE_API void	ResumePreload ()

CORE_API bool	ResumePreloadNonRecursive ()

CORE_API void	OnReadComplete (bool bCanceled, IAsyncReadRequest *ReadRequest)

CORE_API void	FreeRetiredRequests ()

CORE_API void	SerializeSynchronously (void *V, int64 Length)

Protected Member Functions inherited from FArchive
void	SetShouldSkipCompilingAssets (bool Enabled)

Static Protected Member Functions inherited from FArchive
static CORE_API void	LinkProxy (FArchiveState &Inner, FArchiveState &Proxy)

static CORE_API void	UnlinkProxy (FArchiveState &Inner, FArchiveState &Proxy)

Protected Attributes inherited from FPreloadableArchive
FString	ArchiveName

int64	Pos = 0

int64	Size = -1

FEvent *	PendingAsyncComplete = nullptr

TAtomic< bool >	bInitialized

TAtomic< bool >	bIsPreloading

TAtomic< bool >	bIsPreloadingPaused

uint8 *	CacheBytes = nullptr

TAtomic< int64 >	CacheEnd

TUniquePtr< IAsyncReadFileHandle >	AsynchronousHandle

TUniquePtr< FArchive >	SynchronousArchive

TArray< IAsyncReadRequest * >	RetiredRequests

int64	PageSize = DefaultPageSize

FCriticalSection	PreloadLock

bool	bReadCompleteWasCalledInline = false

bool	bIsInlineReadComplete = false

struct FPreloadableArchive::FSavedReadCompleteArguments	SavedReadCompleteArguments

Detailed Description

An FPreloadableArchive that is customized for reading files from IFileManager.

This class also supports registration of instances of this class by filename, which other systems in the engine can use to request an FArchive for the preload file, if it exists, replacing a call they would otherwise make to IFileManager::Get().CreateFileReader.

As with the base class, the preloading can work in either PreloadBytes or PreloadHandle mode.

Activate PreloadBytes mode by passing Flags::PreloadBytes to InitializeAsync. Activate PreloadHandle mode by passing Flags::PreloadHandle to InitializeAsync, optionally or'd with Flags::Prime.

Constructor & Destructor Documentation

◆ FPreloadableFile()

FPreloadableFile::FPreloadableFile ( FStringView FileName )

Member Function Documentation

◆ InitializeAsync()

void FPreloadableFile::InitializeAsync	(	uint32	InFlags = `Flags::None`,
		int64	PrimeSize = `DefaultPrimeSize`
	)

Initialize the FPreloadableFile asynchronously, performing FileOpen operations on another thread. Use IsInitialized or WaitForInitialization to check progress.

◆ TryRegister()

bool FPreloadableFile::TryRegister ( const TSharedPtr< FPreloadableFile > & PreloadableFile )

static

Try to register the given FPreloadableFile instance to handle the next call to TryTakeArchive for its FileName. Will fail if the instance has not been initialized or if another instance has already registered for the Filename. Return whether the instance is currently registered. Returns true if the instance was already registered. Registered files are referenced-counted, and the reference will not be dropped until (1) (TryTakeArchive or UnRegister is called) and (2) (PreloadBytes mode only) the archive returned from TryTakeArchive is deleted.

◆ TryTakeArchive()

FArchive * FPreloadableFile::TryTakeArchive ( const TCHAR * FileName )

static

Look up an FPreloadableFile instance registered for the given FileName, and return an FArchive from it. If found, removes the registration so no future call to TryTakeArchive can sue the same FArchive. If the instance is in PreloadHandle mode, the Lower-Level FArchive will be detached from the FPreloadableFile and returned using DetachLowerLevel. If the instance is in PreloadBytes mode, a ProxyArchive will be returned that forwards call to the FPreloadableFile instance.

◆ UnRegister()

bool FPreloadableFile::UnRegister ( const TSharedPtr< FPreloadableFile > & PreloadableFile )

static

Remove the FPreloadableFile instance if it is registered for its FileName. Returns whether the instance was registered.

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

Engine/Source/Runtime/Core/Public/Misc/PreloadableFile.h
Engine/Source/Runtime/Core/Private/Misc/PreloadableFile.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FPreloadableFile()

Member Function Documentation

◆ InitializeAsync()

◆ TryRegister()

◆ TryTakeArchive()

◆ UnRegister()