FZenStoreWriter

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

Unreal Engine C++ API Reference > Developer > IoStoreUtilities

Inheritance Hierarchy

References

   
Module IoStoreUtilities
Header /Engine/Source/Developer/IoStoreUtilities/Public/ZenStoreWriter.h
Include #include "ZenStoreWriter.h"

Syntax

class FZenStoreWriter : public [IPackageStoreWriter](API\Developer\IoStoreUtilities\IPackageStoreWriter)  

Remarks

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

Constructors

Type Name Description
  FZenStoreWriter ( const FString& OutputPath, const FString& MetadataDirectoryPa..., const ITargetPlatform* TargetP... )  

Destructors

Type Name Description
  ~FZenStoreWriter ()  

Functions

Type Name Description
ZenHostInfo GetHostInfo ()  
void SetBeginCacheCallback ( FBeginCacheCallback&& InBeginCache... ) Delegates to forward PackageWriter events onto UCookOnTheFlyServer when cooking.
void WriteIoStorePackageData ( const FPackageInfo& Info, const FIoBuffer& PackageData, const FPackageStoreEntryResource& ..., const TArray< FFileRegion >& FileR... )  

Overridden from IPackageStoreWriter

Type Name Description
FZenStoreWri... AsZenStoreWriter () Identify as a implmenter of this class from the IPackageStoreWriter api.
void GetEntries ( TFunction< void(TArrayView< const F... ) Returns all cooked package store entries.
FCommitEvent... OnCommit ()  
FEntryCreate... OnEntryCreated ()  
FMarkUpToDat... OnMarkUpToDate ()  

Overridden from ICookedPackageWriter

Type Name Description
EPackageWrit... BeginCacheForCookedPlatformData ( FBeginCacheForCookedPlatformDataInf... )  
void BeginCook ( const FCookInfo& Info ) Signal the start of a cooking pass
void CompleteExportsArchiveForDiff ( FPackageInfo& Info, FLargeMemoryWriter& ExportsArchive ) Append all data to the Exports archive that would normally be done in CommitPackage, used for diffing.
void EndCook ( const FCookInfo& Info ) Signal the end of a cooking pass.
FCookCapabil... GetCookCapabilities () Return cook capabilities/settings this PackageWriter has/requires
FCbObject GetOplogAttachment ( FName PackageName, FUtf8StringView AttachmentKey ) Returns an Attachment that was previously commited for the given PackageName.
TMap< FName,... GetPackageHashes () Cooked package writers asynchronously hash the chunks for each package after CommitPackage.
bool GetPreviousCookedBytes ( const FPackageInfo& Info, FPreviousCookedBytesData& OutData ) Load the bytes of the previously-cooked package, used for diffing
void Initialize ( const FCookInfo& Info ) Delete outdated cooked data, etc.
TUniquePtr< ... LoadPreviousAssetRegistry () Returns an AssetRegistry describing the previous cook results.
void MarkPackagesUpToDate ( TArrayView< const FName > UpToDateP... ) Signal the given cooked package(s) have been checked for changes and have not been modified since the last cook.
void RemoveCookedPackages () Remove all cooked packages from storage.
void RemoveCookedPackages ( TArrayView< const FName > PackageNa... ) Remove the given cooked package(s) from storage; they have been modified since the last cook.
bool TryReadMPCookMessageForPackage ( FName PackageName, FCbObjectView Message ) Read PackageData written by WriteMPCookMessageForPackage on a CookWorker.
TFuture< FCb... WriteMPCookMessageForPackage ( FName PackageName ) Asynchronously create a CompactBinary Object message that replicates all of the package data from package save that is collected in memory and written at end of cook rather than being written to disk during package save.

Overridden from IPackageWriter

Type Name Description
void BeginPackage ( const FBeginPackageInfo& Info ) Mark the beginning of a package store transaction for the specified package
void CommitPackage ( FCommitPackageInfo&& Info ) Finalize a package started with BeginPackage()
void WriteAdditionalFile ( const FAdditionalFileInfo& Info, const FIoBuffer& FileData ) Write separate files written by UObjects during cooking via UObject::CookAdditionalFiles.
void WriteBulkData ( const FBulkDataInfo& Info, const FIoBuffer& BulkData, const TArray< FFileRegion >& FileR... ) Write bulk data for the current package
void WriteLinkerAdditionalData ( const FLinkerAdditionalDataInfo& I..., const FIoBuffer& Data, const TArray< FFileRegion >& FileR... ) Write separate data written by UObjects via FLinkerSave::AdditionalDataToAppend.
void WritePackageData ( const FPackageInfo& Info, FLargeMemoryWriter& ExportsArchive, const TArray< FFileRegion >& FileR... ) Write package data (exports and serialized header)
void WritePackageTrailer ( const FPackageTrailerInfo& Info, const FIoBuffer& Data ) Write the PackageTrailer, a separate segment for some bulkdata that is written the end of the file.

Classes

Type Name Description
Public class FCommitQueue  
Public struct FZenCommitInfo  
Public struct ZenHostInfo  

Constants

Name Description
ReservedOplogKeys  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library