#include <BuildPatchManifest.h>

Inheritance diagram for FBuildPatchAppManifest:

Public Member Functions
	FBuildPatchAppManifest ()

	FBuildPatchAppManifest (const uint32 &InAppID, const FString &AppName)

	FBuildPatchAppManifest (const FBuildPatchAppManifest &Other)

	~FBuildPatchAppManifest ()

virtual uint32	GetAppID () const override

virtual const FString &	GetAppName () const override

virtual const FString &	GetVersionString () const override

virtual const FString &	GetLaunchExe () const override

virtual const FString &	GetLaunchCommand () const override

virtual const TSet< FString > &	GetPrereqIds () const override

virtual const FString &	GetPrereqName () const override

virtual const FString &	GetPrereqPath () const override

virtual const FString &	GetPrereqArgs () const override

virtual int64	GetDownloadSize () const override

virtual int64	GetDownloadSize (const TSet< FString > &Tags) const override

virtual int64	GetDeltaDownloadSize (const TSet< FString > &Tags, const IBuildManifestRef &PreviousVersion) const override

virtual int64	GetDeltaDownloadSize (const TSet< FString > &Tags, const IBuildManifestRef &PreviousVersion, const TSet< FString > &PreviousTags) const override

virtual int64	GetBuildSize () const override

virtual int64	GetBuildSize (const TSet< FString > &Tags) const override

virtual TArray< FString >	GetBuildFileList () const override

virtual TArray< FStringView >	GetBuildFileListView () const override

virtual TArray< FString >	GetBuildFileList (const TSet< FString > &Tags) const override

virtual TArray< FStringView >	GetBuildFileListView (const TSet< FString > &Tags) const override

virtual int64	GetFileSize (FStringView Filename) const override

virtual int64	GetFileSize (const TArray< FString > &Filenames) const override

virtual int64	GetFileSize (const TSet< FString > &Filenames) const override

virtual bool	GetFileHash (const FString &Filename, FSHAHash &OutHash) const override

virtual TSet< FString >	GetFileTagList () const override

virtual void	GetFileTagList (TSet< FString > &Tags) const override

virtual void	GetOutdatedFiles (const IBuildManifestRef &OldManifest, TSet< FString > &OutdatedFiles) const override

virtual void	GetRemovableFiles (const IBuildManifestRef &OldManifest, TArray< FString > &RemovableFiles) const override

virtual void	GetRemovableFiles (const TCHAR *InstallPath, TArray< FString > &RemovableFiles) const override

virtual bool	NeedsResaving () const override

virtual void	CopyCustomFields (const IBuildManifestRef &Other, bool bClobber) override

virtual const IManifestFieldPtr	GetCustomField (const FString &FieldName) const override

virtual const IManifestFieldPtr	SetCustomField (const FString &FieldName, const FString &Value) override

virtual const IManifestFieldPtr	SetCustomField (const FString &FieldName, const double &Value) override

virtual const IManifestFieldPtr	SetCustomField (const FString &FieldName, const int64 &Value) override

virtual void	RemoveCustomField (const FString &FieldName) override

virtual IBuildManifestRef	Duplicate () const override

virtual const FString &	GetBuildId () const

virtual bool	LoadFromFile (const FString &Filename)

virtual bool	DeserializeFromData (const TArray< uint8 > &DataInput)

virtual bool	DeserializeFromJSON (const FString &JSONInput)

virtual bool	SaveToFile (const FString &Filename, BuildPatchServices::EFeatureLevel SaveFormat=BuildPatchServices::EFeatureLevel::Latest)

virtual void	SerializeToJSON (FString &JSONOutput)

virtual BuildPatchServices::EFeatureLevel	GetFeatureLevel () const

virtual void	GetChunksRequiredForFiles (const TSet< FString > &Filenames, TSet< FGuid > &RequiredChunks) const

virtual uint32	GetNumberOfChunkReferences (const FGuid &ChunkGuid) const

virtual int64	GetDataSize (const FGuid &DataGuid) const

virtual int64	GetDataSize (const TArray< FGuid > &DataGuids) const

virtual int64	GetDataSize (const TSet< FGuid > &DataGuids) const

virtual uint32	GetNumFiles () const

virtual void	GetFileList (TArray< FString > &Filenames) const

virtual void	GetFileList (TArray< FStringView > &Filenames) const

virtual void	GetFileList (TSet< FString > &Filenames) const

virtual void	GetTaggedFileList (const TSet< FString > &Tags, TArray< FString > &TaggedFiles) const

virtual void	GetTaggedFileList (const TSet< FString > &Tags, TArray< FStringView > &TaggedFiles) const

virtual void	GetTaggedFileList (const TSet< FString > &Tags, TSet< FString > &TaggedFiles) const

virtual void	GetDataList (TArray< FGuid > &DataGuids) const

virtual void	GetDataList (TSet< FGuid > &DataGuids) const

virtual const BuildPatchServices::FFileManifest *	GetFileManifest (const FString &Filename) const

virtual bool	IsFileDataManifest () const

virtual bool	GetChunkHash (const FGuid &ChunkGuid, uint64 &OutHash) const

virtual bool	GetChunkShaHash (const FGuid &ChunkGuid, FSHAHash &OutHash) const

virtual const BuildPatchServices::FChunkInfo *	GetChunkInfo (const FGuid &ChunkGuid) const

virtual bool	GetFileHash (const FGuid &FileGuid, FSHAHash &OutHash) const

virtual bool	GetFilePartHash (const FGuid &FilePartGuid, uint64 &OutHash) const

virtual int32	EnumerateProducibleChunks (const TSet< FString > &TagSet, const TSet< FGuid > &ChunksRequired, TSet< FGuid > &ChunksAvailable) const

virtual void	GetOutdatedFiles (const FBuildPatchAppManifestPtr &OldManifest, const FString &InstallDirectory, TSet< FString > &OutDatedFiles) const

virtual void	GetOutdatedFiles (const FBuildPatchAppManifest *OldManifest, const FString &InstallDirectory, TSet< FString > &OutDatedFiles) const

virtual void	GetOutdatedFiles (const FBuildPatchAppManifest *OldManifest, const FString &InstallDirectory, const TSet< FString > &FilesToCheck, TSet< FString > &OutDatedFiles) const

virtual bool	IsFileOutdated (const FBuildPatchAppManifestRef &OldManifest, const FString &Filename) const

virtual bool	IsFileOutdated (const FBuildPatchAppManifest &OldManifest, const FString &Filename) const

virtual void	GetRemovableFiles (const FBuildPatchAppManifest &OldManifest, TArray< FString > &RemovableFiles) const

virtual bool	HasFileAttributes () const

Public Member Functions inherited from IBuildManifest
virtual	~IBuildManifest ()

Protected Member Functions
void	InitLookups ()

Protected Attributes
BuildPatchServices::FManifestMeta	ManifestMeta

BuildPatchServices::FChunkDataList	ChunkDataList

BuildPatchServices::FFileManifestList	FileManifestList

BuildPatchServices::FCustomFields	CustomFields

Friends
class	FBuildDataGenerator

class	FBuildDataFileProcessor

class	BuildPatchServices::FBuildPatchInstaller

class	BuildPatchServices::FManifestBuilder

class	FBuildMergeManifests

class	FBuildDiffManifests

class	FManifestUObject

class	BuildPatchServices::FManifestData

class	BuildPatchServices::FChunkDeltaOptimiser

class	BuildPatchServices::FBuildPatchManifestSet

Detailed Description

Declare the FBuildPatchAppManifest object class. This holds the UObject data, and the implemented build manifest functionality

Constructor & Destructor Documentation

◆ FBuildPatchAppManifest() [1/3]

FBuildPatchAppManifest::FBuildPatchAppManifest ( )

Default constructor

◆ FBuildPatchAppManifest() [2/3]

FBuildPatchAppManifest::FBuildPatchAppManifest	(	const uint32 &	InAppID,
		const FString &	AppName
	)

Basic details constructor

◆ FBuildPatchAppManifest() [3/3]

FBuildPatchAppManifest::FBuildPatchAppManifest ( const FBuildPatchAppManifest & Other )

Copy constructor

◆ ~FBuildPatchAppManifest()

FBuildPatchAppManifest::~FBuildPatchAppManifest ( )

Default destructor

Member Function Documentation

◆ CopyCustomFields()

void FBuildPatchAppManifest::CopyCustomFields	(	const IBuildManifestRef &	Other,
		bool	bClobber
	)

overridevirtual

Copy the custom fields from another manifest into this one. If this manifest has custom fields, matching keys will be overwritten but extras will remain

Parameters

Other	The manifest to copy from
bClobber	Whether to overwrite any already existing fields

Implements IBuildManifest.

◆ DeserializeFromData()

bool FBuildPatchAppManifest::DeserializeFromData ( const TArray< uint8 > & DataInput )

virtual

Sets up the object from the passed in data

Parameters

DataInput The data to deserialize from

Returns: True if successful.

◆ DeserializeFromJSON()

bool FBuildPatchAppManifest::DeserializeFromJSON ( const FString & JSONInput )

virtual

Sets up the object from the passed in JSON string

Parameters

JSONInput The JSON string to deserialize from

Returns: True if successful.

◆ Duplicate()

IBuildManifestRef FBuildPatchAppManifest::Duplicate ( ) const

overridevirtual

Duplicated this manifest to create a copy. Should be used if storing a received manifest as an installed manifest which would then be unique

Returns: A shared ref to the new manifest

Implements IBuildManifest.

◆ EnumerateProducibleChunks()

int32 FBuildPatchAppManifest::EnumerateProducibleChunks	(	const TSet< FString > &	TagSet,
		const TSet< FGuid > &	ChunksRequired,
		TSet< FGuid > &	ChunksAvailable
	)		const

virtual

Populates an array of chunks that should be producible from a local build, given the tagset that is expected to be installed.

Parameters

TagSet	IN The tagset identifying files expected to be installed.
ChunksRequired	IN A list of chunks that are needed.
ChunksAvailable	OUT A list to receive the chunks from ChunksRequired that could be constructed locally.

Returns: the number of chunks added to the ChunksAvailable set.

◆ GetAppID()

uint32 FBuildPatchAppManifest::GetAppID ( ) const

overridevirtual

Get the App ID that this manifest belongs to

Returns: the app ID

Implements IBuildManifest.

◆ GetAppName()

const FString & FBuildPatchAppManifest::GetAppName ( ) const

overridevirtual

Get the name of the App that this manifest belongs to

Returns: the app name

Implements IBuildManifest.

◆ GetBuildFileList() [1/2]

TArray< FString > FBuildPatchAppManifest::GetBuildFileList ( ) const

overridevirtual

Get the list of files in this build. Filenames are all relative to an install directory

Returns: an array containing build files

Implements IBuildManifest.

◆ GetBuildFileList() [2/2]

TArray< FString > FBuildPatchAppManifest::GetBuildFileList ( const TSet< FString > & Tags ) const

overridevirtual

Get the list of files in this build which match a tag from a given set. Filenames are all relative to an install directory

Parameters

Tags	The set of tags to query

Returns: an array containing build files

Implements IBuildManifest.

◆ GetBuildFileListView() [1/2]

TArray< FStringView > FBuildPatchAppManifest::GetBuildFileListView ( ) const

overridevirtual

Get the list of files in this build. Filenames are all relative to an install directory. Filenames returned are a view over memory owned by the BuildManifest

Returns: an array containing build files

Implements IBuildManifest.

◆ GetBuildFileListView() [2/2]

TArray< FStringView > FBuildPatchAppManifest::GetBuildFileListView ( const TSet< FString > & Tags ) const

overridevirtual

Get the list of files in this build which match a tag from a given set. Filenames are all relative to an install directory Filenames returned are a view over memory owned by the BuildManifest

Returns: an array containing build files

Implements IBuildManifest.

◆ GetBuildId()

const FString & FBuildPatchAppManifest::GetBuildId ( ) const

virtual

Returns: The unique build id of this manifest.

◆ GetBuildSize() [1/2]

int64 FBuildPatchAppManifest::GetBuildSize ( ) const

overridevirtual

Get the size of this build

Returns: the build size in bytes

Implements IBuildManifest.

◆ GetBuildSize() [2/2]

int64 FBuildPatchAppManifest::GetBuildSize ( const TSet< FString > & Tags ) const

overridevirtual

Get the size of the build of this set of tags

Parameters

Tags	IN A list of the tags we want to know the size of

Returns: the build size of the tags in bytes

Implements IBuildManifest.

◆ GetChunkHash()

bool FBuildPatchAppManifest::GetChunkHash	(	const FGuid &	ChunkGuid,
		uint64 &	OutHash
	)		const

virtual

Gets the chunk hash for a given chunk

Parameters

ChunkGuid	IN The guid of the chunk to get hash for
OutHash	OUT Receives the hash value if found

Returns: true if we had the hash for this chunk

◆ GetChunkInfo()

const BuildPatchServices::FChunkInfo * FBuildPatchAppManifest::GetChunkInfo ( const FGuid & ChunkGuid ) const

virtual

Gets the FChunkInfo for a given chunk.

Parameters

ChunkGuid The guid of the chunk to get hash for.

Returns: ptr to the FChunkInfo or nullptr if not found.

◆ GetChunkShaHash()

bool FBuildPatchAppManifest::GetChunkShaHash	(	const FGuid &	ChunkGuid,
		FSHAHash &	OutHash
	)		const

virtual

Gets the SHA1 hash for a given chunk

Parameters

ChunkGuid	IN The guid of the chunk to get hash for
OutHash	OUT Receives the hash value if found

Returns: true if we had the hash for this chunk

◆ GetChunksRequiredForFiles()

void FBuildPatchAppManifest::GetChunksRequiredForFiles	(	const TSet< FString > &	Filenames,
		TSet< FGuid > &	RequiredChunks
	)		const

virtual

Provides the set of chunks required to produce the given files.

Parameters

Filenames	IN The set of files.
RequiredChunks	OUT The set of chunk GUIDs needed for those files.

◆ GetCustomField()

const IManifestFieldPtr FBuildPatchAppManifest::GetCustomField ( const FString & FieldName ) const

overridevirtual

Get a custom field from the manifest

Parameters

FieldName The name of the custom field

Returns: An interface to the field

Implements IBuildManifest.

◆ GetDataList() [1/2]

void FBuildPatchAppManifest::GetDataList ( TArray< FGuid > & DataGuids ) const

virtual

Get the list of Guids for all chunks referenced by this manifest

Parameters

DataGuids OUT Receives the array of Guids.

◆ GetDataList() [2/2]

void FBuildPatchAppManifest::GetDataList ( TSet< FGuid > & DataGuids ) const

virtual

◆ GetDataSize() [1/3]

int64 FBuildPatchAppManifest::GetDataSize ( const FGuid & DataGuid ) const

virtual

Returns the size of a particular data file by it's GUID.

Parameters

DataGuid The GUID for the data

Returns: File size, or 0 if this data is not in the manifest.

◆ GetDataSize() [2/3]

int64 FBuildPatchAppManifest::GetDataSize ( const TArray< FGuid > & DataGuids ) const

virtual

Returns the total size of all data files in it's list.

Parameters

DataGuids The GUID array for the data

Returns: Total file size, or 0 if none of this data is in the manifest.

◆ GetDataSize() [3/3]

int64 FBuildPatchAppManifest::GetDataSize ( const TSet< FGuid > & DataGuids ) const

virtual

◆ GetDeltaDownloadSize() [1/2]

int64 FBuildPatchAppManifest::GetDeltaDownloadSize	(	const TSet< FString > &	Tags,
		const IBuildManifestRef &	PreviousVersion
	)		const

overridevirtual

Get the size of the download of this set of tags

Parameters

Tags	IN The tags used for installation, will be applied to both manifests
PreviousVersion	IN The manifest for previous version to compare against

Returns: the minimum download size required in bytes

Implements IBuildManifest.

◆ GetDeltaDownloadSize() [2/2]

int64 FBuildPatchAppManifest::GetDeltaDownloadSize	(	const TSet< FString > &	Tags,
		const IBuildManifestRef &	PreviousVersion,
		const TSet< FString > &	PreviousTags
	)		const

overridevirtual

Get the size of the download of this set of tags

Parameters

Tags	IN The tags used for installation
PreviousVersion	IN The manifest for previous version to compare against
PreviousTags	IN The tags used for previous installation

Returns: the minimum download size required in bytes

Implements IBuildManifest.

◆ GetDownloadSize() [1/2]

int64 FBuildPatchAppManifest::GetDownloadSize ( ) const

overridevirtual

Get the size of this download, assuming fresh install

Returns: the total download size in bytes

Implements IBuildManifest.

◆ GetDownloadSize() [2/2]

int64 FBuildPatchAppManifest::GetDownloadSize ( const TSet< FString > & Tags ) const

overridevirtual

Get the size of the download of this set of tags

Parameters

Tags	IN A list of the tags we want to know the size of

Returns: the download size of the tags in bytes

Implements IBuildManifest.

◆ GetFeatureLevel()

EFeatureLevel FBuildPatchAppManifest::GetFeatureLevel ( ) const

virtual

Gets the feature level for this manifest.

Returns: The highest available feature support

◆ GetFileHash() [1/2]

bool FBuildPatchAppManifest::GetFileHash	(	const FGuid &	FileGuid,
		FSHAHash &	OutHash
	)		const

virtual

Gets the file hash for given file data

Parameters

FileGuid	IN The guid of the file data to get hash for
OutHash	OUT Receives the hash value if found

Returns: true if we had the hash for this file

◆ GetFileHash() [2/2]

bool FBuildPatchAppManifest::GetFileHash	(	const FString &	Filename,
		FSHAHash &	OutHash
	)		const

overridevirtual

Gets the file hash for a given file

Parameters

Filename	IN The filename in the build
OutHash	OUT Receives the hash value if found

Returns: true if we had the hash for this file

Implements IBuildManifest.

◆ GetFileList() [1/3]

void FBuildPatchAppManifest::GetFileList ( TArray< FString > & Filenames ) const

virtual

Get the list of files described by this manifest

Parameters

Filenames OUT Receives the list of files.

◆ GetFileList() [2/3]

void FBuildPatchAppManifest::GetFileList ( TArray< FStringView > & Filenames ) const

virtual

◆ GetFileList() [3/3]

void FBuildPatchAppManifest::GetFileList ( TSet< FString > & Filenames ) const

virtual

◆ GetFileManifest()

const FFileManifest * FBuildPatchAppManifest::GetFileManifest ( const FString & Filename ) const

virtual

Returns the manifest for a particular file in the app, nullptr if non-existing

Parameters

Filename The filename.

Returns: The file manifest, or invalid ptr

◆ GetFilePartHash()

bool FBuildPatchAppManifest::GetFilePartHash	(	const FGuid &	FilePartGuid,
		uint64 &	OutHash
	)		const

virtual

Gets the file hash for given file data. Valid for non-chunked manifest

Parameters

FileGuid	IN The guid of the file data to get hash for
OutHash	OUT Receives the hash value if found

Returns: true if we had the hash for this file

◆ GetFileSize() [1/3]

int64 FBuildPatchAppManifest::GetFileSize ( const TArray< FString > & Filenames ) const

overridevirtual

Returns the total size of all files in the array

Parameters

Filenames The array of files.

Returns: the total size of files in array.

Implements IBuildManifest.

◆ GetFileSize() [2/3]

int64 FBuildPatchAppManifest::GetFileSize ( const TSet< FString > & Filenames ) const

overridevirtual

Returns the total size of all files in the set

Parameters

Filenames The set of files.

Returns: the total size of files in set.

Implements IBuildManifest.

◆ GetFileSize() [3/3]

int64 FBuildPatchAppManifest::GetFileSize ( FStringView Filename ) const

overridevirtual

Returns the size of a particular file in the build

Parameters

Filename The file.

Returns: the file size.

Implements IBuildManifest.

◆ GetFileTagList() [1/2]

TSet< FString > FBuildPatchAppManifest::GetFileTagList ( ) const

overridevirtual

Get the list of install tags in this manifest

Returns: the tags referenced.

Implements IBuildManifest.

◆ GetFileTagList() [2/2]

void FBuildPatchAppManifest::GetFileTagList ( TSet< FString > & Tags ) const

overridevirtual

Get the list of install tags in this manifest

Parameters

Tags	OUT Receives the tags referenced.

Implements IBuildManifest.

◆ GetLaunchCommand()

const FString & FBuildPatchAppManifest::GetLaunchCommand ( ) const

overridevirtual

Get the command line arguments that the launch exe should be ran with

Returns: the launch command line

Implements IBuildManifest.

◆ GetLaunchExe()

const FString & FBuildPatchAppManifest::GetLaunchExe ( ) const

overridevirtual

Get the local install path to the exe that launches the App

Returns: local path to the launch exe

Implements IBuildManifest.

◆ GetNumberOfChunkReferences()

uint32 FBuildPatchAppManifest::GetNumberOfChunkReferences ( const FGuid & ChunkGuid ) const

virtual

Get the number of times a chunks is referenced in this manifest

Parameters

ChunkGuid The chunk GUID

Returns: The number of references to this chunk

◆ GetNumFiles()

uint32 FBuildPatchAppManifest::GetNumFiles ( ) const

virtual

Returns the number of files in this build.

Returns: The number of files.

◆ GetOutdatedFiles() [1/4]

void FBuildPatchAppManifest::GetOutdatedFiles	(	const FBuildPatchAppManifest *	OldManifest,
		const FString &	InstallDirectory,
		const TSet< FString > &	FilesToCheck,
		TSet< FString > &	OutDatedFiles
	)		const

virtual

◆ GetOutdatedFiles() [2/4]

void FBuildPatchAppManifest::GetOutdatedFiles	(	const FBuildPatchAppManifest *	OldManifest,
		const FString &	InstallDirectory,
		TSet< FString > &	OutDatedFiles
	)		const

virtual

◆ GetOutdatedFiles() [3/4]

void FBuildPatchAppManifest::GetOutdatedFiles	(	const FBuildPatchAppManifestPtr &	OldManifest,
		const FString &	InstallDirectory,
		TSet< FString > &	OutDatedFiles
	)		const

virtual

Gets a list of files that have changed or are new in the this manifest, compared to those in the old manifest, or are missing from disk.

Parameters

OldManifest	IN The Build Manifest that is currently installed. Shared Ptr - Can be invalid.
InstallDirectory	IN The Build installation directory, so that it can be checked for missing files.
OutDatedFiles	OUT The files that changed hash, are new, are wrong size, or missing on disk.

◆ GetOutdatedFiles() [4/4]

void FBuildPatchAppManifest::GetOutdatedFiles	(	const IBuildManifestRef &	OldManifest,
		TSet< FString > &	OutdatedFiles
	)		const

overridevirtual

Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.

Parameters

OldManifest	IN The Build Manifest that is currently installed.
RemovableFiles	OUT A list to receive the files that may be removed.

Implements IBuildManifest.

◆ GetPrereqArgs()

const FString & FBuildPatchAppManifest::GetPrereqArgs ( ) const

overridevirtual

Get the command line arguments that should be passed to the prerequisites installer

Returns: the prerequisites installer command line arguments

Implements IBuildManifest.

◆ GetPrereqIds()

const TSet< FString > & FBuildPatchAppManifest::GetPrereqIds ( ) const

overridevirtual

Get the list of prereq ids that the prereq installer of this manifest satisfies

Returns: the set containing the prereq ids.

Implements IBuildManifest.

◆ GetPrereqName()

const FString & FBuildPatchAppManifest::GetPrereqName ( ) const

overridevirtual

Get the name of the prerequisites installer for the app

Returns: the prerequisites installer name

Implements IBuildManifest.

◆ GetPrereqPath()

const FString & FBuildPatchAppManifest::GetPrereqPath ( ) const

overridevirtual

Get the path to the prerequisites installer exe

Returns: local path to the prerequisites installer

Implements IBuildManifest.

◆ GetRemovableFiles() [1/3]

void FBuildPatchAppManifest::GetRemovableFiles	(	const FBuildPatchAppManifest &	OldManifest,
		TArray< FString > &	RemovableFiles
	)		const

virtual

Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.

Parameters

OldManifest	IN The Build Manifest that is currently installed.
RemovableFiles	OUT A list to receive the files that may be removed.

◆ GetRemovableFiles() [2/3]

void FBuildPatchAppManifest::GetRemovableFiles	(	const IBuildManifestRef &	OldManifest,
		TArray< FString > &	RemovableFiles
	)		const

overridevirtual

Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.

Parameters

OldManifest	IN The Build Manifest that is currently installed.
RemovableFiles	OUT A list to receive the files that may be removed.

Implements IBuildManifest.

◆ GetRemovableFiles() [3/3]

void FBuildPatchAppManifest::GetRemovableFiles	(	const TCHAR *	InstallPath,
		TArray< FString > &	RemovableFiles
	)		const

overridevirtual

Gets a list of files that are installed in InstallPath, but no longer required by this Manifest.

Parameters

InstallPath	IN The path to the currently installed files.
RemovableFiles	OUT A list to receive the files that may be removed.

Implements IBuildManifest.

◆ GetTaggedFileList() [1/3]

void FBuildPatchAppManifest::GetTaggedFileList	(	const TSet< FString > &	Tags,
		TArray< FString > &	TaggedFiles
	)		const

virtual

Get the list of files that are tagged with the provided tags

Parameters

Tags	The tags for the required file groups.
TaggedFiles	OUT Receives the tagged files.

◆ GetTaggedFileList() [2/3]

void FBuildPatchAppManifest::GetTaggedFileList	(	const TSet< FString > &	Tags,
		TArray< FStringView > &	TaggedFiles
	)		const

virtual

◆ GetTaggedFileList() [3/3]

void FBuildPatchAppManifest::GetTaggedFileList	(	const TSet< FString > &	Tags,
		TSet< FString > &	TaggedFiles
	)		const

virtual

◆ GetVersionString()

const FString & FBuildPatchAppManifest::GetVersionString ( ) const

overridevirtual

Get the string App version that this manifest describes

Returns: the version string

Implements IBuildManifest.

◆ HasFileAttributes()

bool FBuildPatchAppManifest::HasFileAttributes ( ) const

virtual

Returns: True if any files in this manifest have file attributes to be set

◆ InitLookups()

void FBuildPatchAppManifest::InitLookups ( )

protected

Setups the lookup maps that optimize data access, should be called when Data changes

◆ IsFileDataManifest()

bool FBuildPatchAppManifest::IsFileDataManifest ( ) const

virtual

Gets whether this manifest is made up of file data instead of chunk data

Returns: True if the build is made from file data. False if the build is constructed from chunk data.

◆ IsFileOutdated() [1/2]

bool FBuildPatchAppManifest::IsFileOutdated	(	const FBuildPatchAppManifest &	OldManifest,
		const FString &	Filename
	)		const

virtual

◆ IsFileOutdated() [2/2]

bool FBuildPatchAppManifest::IsFileOutdated	(	const FBuildPatchAppManifestRef &	OldManifest,
		const FString &	Filename
	)		const

virtual

Check a single file to see if it will be effected by patching from a previous version.

Parameters

OldManifest	The Build Manifest that is currently installed. Shared Ref - Implicitly valid.
Filename	The Build installation directory, so that it can be checked for missing files.

◆ LoadFromFile()

bool FBuildPatchAppManifest::LoadFromFile ( const FString & Filename )

virtual

Sets up the internal map from a file

Parameters

Filename The file to load JSON from

Returns: True if successful.

◆ NeedsResaving()

bool FBuildPatchAppManifest::NeedsResaving ( ) const

overridevirtual

Checks the manifest format version to see if this manifest was loaded from latest data

Returns: True if the manifest was created from the latest format

Implements IBuildManifest.

◆ RemoveCustomField()

void FBuildPatchAppManifest::RemoveCustomField ( const FString & FieldName )

overridevirtual

Remove a custom field from the manifest

Parameters

FieldName The name of the custom field

Implements IBuildManifest.

◆ SaveToFile()

bool FBuildPatchAppManifest::SaveToFile	(	const FString &	Filename,
		BuildPatchServices::EFeatureLevel	SaveFormat = `BuildPatchServices::EFeatureLevel::Latest`
	)

virtual

Saves out the manifest information.

Parameters

Filename	The file to save to.
SaveFormat	The feature level that the intended client has support for, which the manifest will need saving as. A manifest file cannot be downgraded, the function will fail if the provided value is less than GetFeatureLevel().

Returns: True if successful.

◆ SerializeToJSON()

void FBuildPatchAppManifest::SerializeToJSON ( FString & JSONOutput )

virtual

Creates the object in JSON format

Parameters

JSONOutput A string to receive the JSON representation

◆ SetCustomField() [1/3]

const IManifestFieldPtr FBuildPatchAppManifest::SetCustomField	(	const FString &	FieldName,
		const double &	Value
	)

overridevirtual

Implements IBuildManifest.

◆ SetCustomField() [2/3]

const IManifestFieldPtr FBuildPatchAppManifest::SetCustomField	(	const FString &	FieldName,
		const FString &	Value
	)

overridevirtual

Various functions for setting a custom field in the manifest

Parameters

FieldName	The name of the custom field
Value	The value for the field

Returns: An interface to the field that was created

Implements IBuildManifest.

◆ SetCustomField() [3/3]

const IManifestFieldPtr FBuildPatchAppManifest::SetCustomField	(	const FString &	FieldName,
		const int64 &	Value
	)

overridevirtual

Implements IBuildManifest.

Friends And Related Symbol Documentation

◆ BuildPatchServices::FBuildPatchInstaller

friend class BuildPatchServices::FBuildPatchInstaller

friend

◆ BuildPatchServices::FBuildPatchManifestSet

friend class BuildPatchServices::FBuildPatchManifestSet

friend

◆ BuildPatchServices::FChunkDeltaOptimiser

friend class BuildPatchServices::FChunkDeltaOptimiser

friend

◆ BuildPatchServices::FManifestBuilder

friend class BuildPatchServices::FManifestBuilder

friend

◆ BuildPatchServices::FManifestData

friend class BuildPatchServices::FManifestData

friend

◆ FBuildDataFileProcessor

friend class FBuildDataFileProcessor

friend

◆ FBuildDataGenerator

friend class FBuildDataGenerator

friend

◆ FBuildDiffManifests

friend class FBuildDiffManifests

friend

◆ FBuildMergeManifests

friend class FBuildMergeManifests

friend

◆ FManifestUObject

friend class FManifestUObject

friend

Member Data Documentation

◆ ChunkDataList

BuildPatchServices::FChunkDataList FBuildPatchAppManifest::ChunkDataList

protected

◆ CustomFields

BuildPatchServices::FCustomFields FBuildPatchAppManifest::CustomFields

protected

◆ FileManifestList

BuildPatchServices::FFileManifestList FBuildPatchAppManifest::FileManifestList

protected

◆ ManifestMeta

BuildPatchServices::FManifestMeta FBuildPatchAppManifest::ManifestMeta

protected

Holds the actual manifest data. Some other variables point to the memory held by these objects

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

Engine/Source/Runtime/Online/BuildPatchServices/Private/BuildPatchManifest.h
Engine/Source/Runtime/Online/BuildPatchServices/Private/BuildPatchManifest.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ FBuildPatchAppManifest() [1/3]

◆ FBuildPatchAppManifest() [2/3]

◆ FBuildPatchAppManifest() [3/3]

◆ ~FBuildPatchAppManifest()

Member Function Documentation

◆ CopyCustomFields()

◆ DeserializeFromData()

◆ DeserializeFromJSON()

◆ Duplicate()

◆ EnumerateProducibleChunks()

◆ GetAppID()

◆ GetAppName()

◆ GetBuildFileList() [1/2]

◆ GetBuildFileList() [2/2]

◆ GetBuildFileListView() [1/2]

◆ GetBuildFileListView() [2/2]

◆ GetBuildId()

◆ GetBuildSize() [1/2]

◆ GetBuildSize() [2/2]

◆ GetChunkHash()

◆ GetChunkInfo()

◆ GetChunkShaHash()

◆ GetChunksRequiredForFiles()

◆ GetCustomField()

◆ GetDataList() [1/2]

◆ GetDataList() [2/2]

◆ GetDataSize() [1/3]

◆ GetDataSize() [2/3]

◆ GetDataSize() [3/3]

◆ GetDeltaDownloadSize() [1/2]

◆ GetDeltaDownloadSize() [2/2]

◆ GetDownloadSize() [1/2]

◆ GetDownloadSize() [2/2]

◆ GetFeatureLevel()

◆ GetFileHash() [1/2]

◆ GetFileHash() [2/2]

◆ GetFileList() [1/3]

◆ GetFileList() [2/3]

◆ GetFileList() [3/3]

◆ GetFileManifest()

◆ GetFilePartHash()

◆ GetFileSize() [1/3]

◆ GetFileSize() [2/3]

◆ GetFileSize() [3/3]

◆ GetFileTagList() [1/2]

◆ GetFileTagList() [2/2]

◆ GetLaunchCommand()

◆ GetLaunchExe()

◆ GetNumberOfChunkReferences()

◆ GetNumFiles()

◆ GetOutdatedFiles() [1/4]

◆ GetOutdatedFiles() [2/4]

◆ GetOutdatedFiles() [3/4]

◆ GetOutdatedFiles() [4/4]

◆ GetPrereqArgs()

◆ GetPrereqIds()

◆ GetPrereqName()

◆ GetPrereqPath()

◆ GetRemovableFiles() [1/3]

◆ GetRemovableFiles() [2/3]

◆ GetRemovableFiles() [3/3]

◆ GetTaggedFileList() [1/3]

◆ GetTaggedFileList() [2/3]

◆ GetTaggedFileList() [3/3]

◆ GetVersionString()

◆ HasFileAttributes()

◆ InitLookups()

◆ IsFileDataManifest()

◆ IsFileOutdated() [1/2]

◆ IsFileOutdated() [2/2]

◆ LoadFromFile()

◆ NeedsResaving()

◆ RemoveCustomField()

◆ SaveToFile()