1. Epic GamesDeveloper
  3. FZenStoreWriter

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

Remarks

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

Constructors

  Type Name Description
Public function  

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

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const ZenHostInfo  
Public function void

SetBeginCacheCallback ( FBeginCacheCallback&& InBeginCacheCallback
)

 Delegates to forward PackageWriter events onto UCookOnTheFlyServer when cooking.
Public function void  
Public function void

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

  

Overridden from IPackageStoreWriter

  Type Name Description
Public function Virtual FZenStoreWriter * Identify as a implmenter of this class from the IPackageStoreWriter api.
Public function Virtual void Returns all cooked package store entries.
Public function Virtual FCommitEvent &  
Public function Virtual FEntryCreatedEvent &  
Public function Virtual FMarkUpToDateEvent &  

Overridden from ICookedPackageWriter

  Type Name Description
Public function Virtual EPackageWriterResult

BeginCacheForCookedPlatformData ( FBeginCacheForCookedPlatformDataInfo& Info
)

  
Public function Virtual void

BeginCook ( const FCookInfo& Info
)

 Signal the start of a cooking pass
Public function Virtual void

CompleteExportsArchiveForDiff ( FPackageInfo& Info,
FLargeMemoryWriter& ExportsArchive
)

 Append all data to the Exports archive that would normally be done in CommitPackage, used for diffing.
Public function Virtual void

EndCook ( const FCookInfo& Info
)

 Signal the end of a cooking pass.
Public function Virtual Const FCookCapabilities Return cook capabilities/settings this PackageWriter has/requires
Public function Virtual FCbObject

GetOplogAttachment ( FName PackageName,
FUtf8StringView AttachmentKey
)

 Returns an Attachment that was previously commited for the given PackageName.
Public function Virtual TMap< FName, TRefCountPtr< FPackageHashes > > & Cooked package writers asynchronously hash the chunks for each package after CommitPackage.
Public function Virtual bool

GetPreviousCookedBytes ( const FPackageInfo& Info,
FPreviousCookedBytesData& OutData
)

 Load the bytes of the previously-cooked package, used for diffing
Public function Virtual void

Initialize ( const FCookInfo& Info
)

 Delete outdated cooked data, etc.
Public function Virtual TUniquePtr< FAssetRegistryState > Returns an AssetRegistry describing the previous cook results.
Public function Virtual void Remove all cooked packages from storage.
Public function Virtual void

RemoveCookedPackages ( TArrayView< const FName > PackageNamesToRemove
)

 Remove the given cooked package(s) from storage; they have been modified since the last cook.
Public function Virtual bool Read PackageData written by WriteMPCookMessageForPackage on a CookWorker.
Public function Virtual void

UpdatePackageModificationStatus ( FName PackageName,
bool bIterativelyUnmodified,
bool& bInOutShouldIterativelySkip
)

 During iterative cooking, signal the cooked package has been checked for changes, and decide whether it should be iteratively skipped.
Public function Virtual TFuture< FCbObject > 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
Public function Virtual void

BeginPackage ( const FBeginPackageInfo& Info
)

 Mark the beginning of a package store transaction for the specified package
Public function Virtual void

CommitPackage ( FCommitPackageInfo&& Info
)

 Finalize a package started with BeginPackage()
Public function Virtual Const FCapabilities Return capabilities/settings this PackageWriter has/requires
Public function Virtual void

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

 Overridden by PackageWriters that handle bDeterminismDebug=true.
Public function Virtual void

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

 Write separate files written by UObjects during cooking via UObject::CookAdditionalFiles.
Public function Virtual void

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

 Write bulk data for the current package
Public function Virtual void

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

 Write separate data written by UObjects via FLinkerSave::AdditionalDataToAppend.
Public function Virtual void

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

 Write package data (exports and serialized header)
Public function Virtual 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

On this page