1. Epic GamesDeveloper
  3. FZenStoreWriter

FZenStoreWriter

A PackageStoreWriter that saves cooked packages for use by IoStore, and stores them in the Zen storage service.

API > API/Developer > API/Developer/IoStoreUtilities

A PackageStoreWriter that saves cooked packages for use by IoStore, and stores them in the Zen storage service.

   
Name FZenStoreWriter
Type class
Header File /Engine/Source/Developer/IoStoreUtilities/Public/ZenStoreWriter.h
Include Path #include "ZenStoreWriter.h"

Syntax

class FZenStoreWriter : public IPackageStoreWriter

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FZenStoreWriter ( const FString& OutputPath,
const FString& MetadataDirectoryPath,
const ITargetPlatform* TargetPlatform,
TSharedRef< ICookArtifactReader > CookArtifactReader
)

   ZenStoreWriter.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FZenStoreWriter()

   ZenStoreWriter.h  

Classes

Name Remarks
FCommitQueue  

Structs

Name Remarks
FBulkDataEntry  
FFileDataEntry  
FPackageDataEntry  
FPendingPackageState  
FZenCommitInfo  
ZenHostInfo  

Constants

Name Type Remarks Include Path
ReservedOplogKeys TArray< const UTF8CHAR * >   ZenStoreWriter.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllPackageHashes TMap< FName, TRefCountPtr< FPackageHashes > >   ZenStoreWriter.h  
BeginCacheCallback FBeginCacheCallback   ZenStoreWriter.h  
bInitialized bool   ZenStoreWriter.h  
bProvidePerPackageResults bool   ZenStoreWriter.h  
CommitEvent FCommitEvent   ZenStoreWriter.h  
CommitEventCriticalSection FCriticalSection   ZenStoreWriter.h  
CommitQueue TUniquePtr< FCommitQueue >   ZenStoreWriter.h  
CommitThread TFuture< void >   ZenStoreWriter.h  
CompressionLevel FOodleDataCompression::ECompressionLevel   ZenStoreWriter.h  
Compressor FOodleDataCompression::ECompressor   ZenStoreWriter.h  
CookArtifactReader TSharedRef< ICookArtifactReader >   ZenStoreWriter.h  
CookedPackagesInfo TArray< FOplogCookInfo >   ZenStoreWriter.h  
CookMode ICookedPackageWriter::FCookInfo::ECookMode   ZenStoreWriter.h  
EntriesLock FRWLock   ZenStoreWriter.h  
EntryCreatedEvent FEntryCreatedEvent   ZenStoreWriter.h  
HttpClient TUniquePtr< UE::FZenStoreHttpClient >   ZenStoreWriter.h  
IsLocalConnection bool   ZenStoreWriter.h  
MarkUpToDateEvent FMarkUpToDateEvent   ZenStoreWriter.h  
MetadataDirectoryPath FString   ZenStoreWriter.h  
OplogId FString   ZenStoreWriter.h  
OutputPath FString   ZenStoreWriter.h  
PackageAdditionalFiles TMap< FName, TArray< FString > >   ZenStoreWriter.h  
PackageNameToIndex TMap< FName, int32 >   ZenStoreWriter.h  
PackagesCriticalSection FCriticalSection   ZenStoreWriter.h  
PackageStoreEntries TArray< FPackageStoreEntryResource >   ZenStoreWriter.h  
PackageStoreOptimizer TUniquePtr< FPackageStoreOptimizer >   ZenStoreWriter.h  
PendingPackages TMap< FName, TUniquePtr< FPendingPackageState > >   ZenStoreWriter.h  
ProjectId FString   ZenStoreWriter.h  
RegisterDeterminismHelperCallback FRegisterDeterminismHelperCallback   ZenStoreWriter.h  
TargetPlatform const ITargetPlatform &   ZenStoreWriter.h  
TargetPlatformFName const FName   ZenStoreWriter.h  
ZenFileSystemManifest TUniquePtr< FZenFileSystemManifest >   ZenStoreWriter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual EPackageWriterResult BeginCacheForCookedPlatformData ( FBeginCacheForCookedPlatformDataInfo& Info
)

   ZenStoreWriter.h  

virtual void BeginCook ( const FCookInfo& Info
)

   ZenStoreWriter.h  

virtual void BeginPackage ( const FBeginPackageInfo& Info
)

   ZenStoreWriter.h  

virtual void CommitPackage ( FCommitPackageInfo&& Info
)

   ZenStoreWriter.h  

void CompleteExportsArchiveForDiff ( FPackageInfo& Info,
FLargeMemoryWriter& ExportsArchive
)

   ZenStoreWriter.h  

virtual void EndCook ( const FCookInfo& Info
)

   ZenStoreWriter.h  

virtual FCapabilities GetCapabilities()

   ZenStoreWriter.h  

virtual ECommitStatus GetCommitStatus ( FName PackageName
)

   ZenStoreWriter.h  

virtual FCookCapabilities GetCookCapabilities()

   ZenStoreWriter.h  

ZenHostInfo GetHostInfo()

   ZenStoreWriter.h  

virtual FCbObject GetOplogAttachment ( FName PackageName,
FUtf8StringView AttachmentKey
)

   ZenStoreWriter.h  

virtual void GetOplogAttachments ( TArrayView< FName > PackageNames,
TArrayView< FUtf8StringView > AttachmentKeys,
TUniqueFunction< void(FName PackageName, FUtf8StringView AttachmentKey, FCbObject&&Attachment)>&& ...
)

   ZenStoreWriter.h  

virtual TMap< FName, TRefCountPtr< FPackageHashes > > & GetPackageHashes()

   ZenStoreWriter.h  

bool GetPreviousCookedBytes ( const FPackageInfo& Info,
FPreviousCookedBytesData& OutData
)

   ZenStoreWriter.h  

virtual void Initialize ( const FCookInfo& Info
)

   ZenStoreWriter.h  

TUniquePtr< FAssetRegistryState > LoadPreviousAssetRegistry()

   ZenStoreWriter.h  

virtual void RegisterDeterminismHelper ( UObject* SourceObject,
const TRefCountPtr< UE::Cook::IDeterminismHelper >& DeterminismHelper
)

   ZenStoreWriter.h  

virtual void RemoveCookedPackages ()

   ZenStoreWriter.h  

virtual void RemoveCookedPackages ( TArrayView< const FName > PackageNamesToRemove
)

   ZenStoreWriter.h  

void SetBeginCacheCallback ( FBeginCacheCallback&& InBeginCacheCallback
)

 Delegates to forward PackageWriter events onto UCookOnTheFlyServer when cooking. ZenStoreWriter.h  

void SetRegisterDeterminismHelperCallback ( FRegisterDeterminismHelperCallback&& InRegisterDeterminismHelperCallback
)

   ZenStoreWriter.h  

virtual bool TryReadMPCookMessageForPackage ( FName PackageName,
FCbObjectView Message
)

   ZenStoreWriter.h  

virtual void UpdatePackageModificationStatus ( FName PackageName,
bool bIncrementallyUnmodified,
bool& bInOutShouldIncrementallySkip
)

   ZenStoreWriter.h  

virtual void WriteAdditionalFile ( const FAdditionalFileInfo& Info,
const FIoBuffer& FileData
)

   ZenStoreWriter.h  

virtual void WriteBulkData ( const FBulkDataInfo& Info,
const FIoBuffer& BulkData,
const TArray< FFileRegion >& FileRegions
)

   ZenStoreWriter.h  

void WriteIoStorePackageData ( const FPackageInfo& Info,
const FIoBuffer& PackageData,
const FPackageStoreEntryResource& PackageStoreEntry,
const TArray< FFileRegion >& FileRegions
)

   ZenStoreWriter.h  

virtual void WriteLinkerAdditionalData ( const FLinkerAdditionalDataInfo& Info,
const FIoBuffer& Data,
const TArray< FFileRegion >& FileRegions
)

   ZenStoreWriter.h  

virtual TFuture< FCbObject > WriteMPCookMessageForPackage ( FName PackageName
)

   ZenStoreWriter.h  

virtual void WritePackageData ( const FPackageInfo& Info,
FLargeMemoryWriter& ExportsArchive,
const TArray< FFileRegion >& FileRegions
)

   ZenStoreWriter.h  

virtual void WritePackageTrailer ( const FPackageTrailerInfo& Info,
const FIoBuffer& Data
)

   ZenStoreWriter.h  

Overridden from IPackageStoreWriter

Name Remarks Include Path Unreal Specifiers

virtual FZenStoreWriter * AsZenStoreWriter()

 Identify as a implmenter of this class from the IPackageStoreWriter api. ZenStoreWriter.h  

virtual void GetEntries ( TFunction< void(TArrayView< const FPackageStoreEntryResource >, TArrayView< const FOplogCookInfo >)>...
)

 Returns all cooked package store entries. ZenStoreWriter.h  

virtual FCommitEvent & OnCommit()

   ZenStoreWriter.h  

virtual FEntryCreatedEvent & OnEntryCreated()

   ZenStoreWriter.h  

virtual FMarkUpToDateEvent & OnMarkUpToDate()

   ZenStoreWriter.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsReservedOplogKey ( FUtf8StringView Key
)

   ZenStoreWriter.h  

static void StaticInit()

   ZenStoreWriter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page