FZenStoreWriter

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

Windows
MacOS
Linux

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

Name Description

Public function

FZenStoreWriter

(
    const FString& OutputPath,
    const FString& MetadataDirectoryPa...,
    const ITargetPlatform* TargetP...
)

Destructors

Name Description

Public function

~FZenStoreWriter()

Functions

Name Description

Public function Virtual

void

 

GetEntries

(
    TFunction< void< const F...
)

Public function

void

 

WriteIoStorePackageData

(
    const FPackageInfo& Info,
    const FIoBuffer& PackageData,
    const FPackageStoreEntryResource& ...,
    const TArray< FFileRegion >& FileR...
)

Overridden from IPackageStoreWriter

Name Description

Public function Virtual

FCommitEvent...

 

OnCommit()

Public function Virtual

FMarkUpToDat...

 

OnMarkUpToDate()

Overridden from ICookedPackageWriter

Name Description

Public function Virtual

void

 

BeginCook()

Signal the start of a cooking pass

Public function Virtual

void

 

EndCook()

Signal the end of a cooking pass.

Public function Virtual

void

 

Flush()

Flush any outstanding writes.

Public function Virtual

FCbObject

 

GetOplogAttachment

(
    FName PackageName,
    FUtf8StringView AttachmentKey
)

Returns an Attachment that was previously commited for the given PackageName.

Public function Virtual

void

 

Initialize

(
    const FCookInfo& Info
)

Delete outdated cooked data, etc.

Public function Virtual

TUniquePtr< ...

 

LoadPreviousAssetRegistry()

Returns an AssetRegistry describing the previous cook results.

Public function Virtual

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.

Public function Virtual

void

 

RemoveCookedPackages()

Remove all cooked packages from storage.

Public function Virtual

void

 

RemoveCookedPackages

(
    TArrayView< const FName > PackageNa...
)

Remove the given cooked package(s) from storage; they have been modified since the last cook.

Overridden from IPackageWriter

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

TFuture< FMD...

 

CommitPackage

(
    FCommitPackageInfo&& Info
)

Finalize a package started with BeginPackage()

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 >& FileR...
)

Write bulk data for the current package

Public function Virtual

void

 

WriteLinkerAdditionalData

(
    const FLinkerAdditionalDataInfo& I...,
    const FIoBuffer& Data,
    const TArray< FFileRegion >& FileR...
)

Write separate data written by UObjects via FLinkerSave::AdditionalDataToAppend.

Public function Virtual

void

 

WritePackageData

(
    const FPackageInfo& Info,
    FLargeMemoryWriter& ExportsArchive,
    const TArray< FFileRegion >& FileR...
)

Write package data (exports and serialized header)

Classes

Name

Description

Public class

FCommitQueue

Constants

Name

Description

ReservedOplogKeys