1. Epic GamesDeveloper
  3. IBuildPatchServicesModule

IBuildPatchServicesModule

Interface for the services manager.

Unreal Engine C++ API Reference > Runtime > BuildPatchServices > Interfaces

Inheritance Hierarchy

References

   
Module BuildPatchServices
Header /Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildPatchServicesModule.h
Include #include "Interfaces/IBuildPatchServicesModule.h"

Syntax

class IBuildPatchServicesModule : public IModuleInterface

Remarks

Interface for the services manager.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function void

CancelAllInstallers ( bool WaitForThreads
)

 Call to force the exit out of all current installers, optionally blocks until threads have exited and complete delegates are called.
Public function bool Processes a Build directory to create chunks for new data and produce a manifest, saved to the provided cloud directory.
Public function bool Processes a Cloud Directory to identify and delete any orphaned chunks or files.
Public function Const IBuildInstallerRef

CreateBuildInstaller ( BuildPatchServices::FBuildInstallerConfiguration Configuration,
FBuildPatchInstallerDelegate OnComplete
)

 Factory providing construction of a build installer class.
Public function IBuildInstallStreamerRef Factory providing construction of a build streamer class.
Public function Const BuildPatchServices::IBuildStatisticsRef

CreateBuildStatistics ( const IBuildInstallerRef& Installer
)

 Factory providing construction of a build statistics class.
Public function Const BuildPatchServices::IPatchDataEnumerationRef Factory providing construction of a patch data enumeration class.
Public function bool Takes two manifests as input and outputs the details of the patch.
Public function bool Saves info for an enumeration of patch data referenced from an input file of known format, to a specified output file.
Public function Const TSet< FString > Gets an array of prerequisite identifiers that are registered as installed on this system.
Public function Const const TArray< IBuildInstallerRef > & Gets a list of currently active installers
Public function IBuildManifestPtr

LoadManifestFromFile ( const FString& Filename
)

 Loads a Build Manifest from file and returns the interface
Public function IBuildManifestPtr

MakeManifestFromData ( const TArray< uint8 >& ManifestData
)

 Constructs a Build Manifest from a data
Public function bool

MergeManifests ( const FString& ManifestFilePathA,
const FString& ManifestFilePathB,
const FString& ManifestFilePathC,
const FString& NewVersionString,
const FString& SelectionDetailFilePath
)

 Takes two manifests as input, in order to merge together producing a new manifest containing all files.
Public function IBuildPatchServicesModule::FSimpleEvent TBaseMulticastDelegate_NoParams  
Public function bool Process a pair of manifests to produce additional delta data which reduces the patch directly between them.
Public function bool Packages data referenced by a manifest file into chunkdb files, supporting a maximum filesize per chunkdb.
Public function void

RegisterAppInstallation ( IBuildManifestRef AppManifest,
const FString AppInstallDirectory
)

 Registers an installation on this machine.
Public function bool

SaveManifestToFile ( const FString& Filename,
IBuildManifestRef Manifest
)

 Saves a Build Manifest to file
Public function void Sets the Analytics provider that will be used to register errors with patch/build installs
Public function void

SetBackupDirectory ( const FString& BackupDir
)

 Sets the backup directory where files that are being clobbered by repair/patch will be placed.
Public function void Sets the cloud directory list where chunks and manifests will be pulled from and saved to.
Public function void

SetCloudDirectory ( FString CloudDir
)

 Sets the cloud directory where chunks and manifests will be pulled from and saved to.
Public function void

SetStagingDirectory ( const FString& StagingDir
)

 Sets the directory used for staging intermediate files.
Public function bool

UnregisterAppInstallation ( const FString AppInstallDirectory
)

 Unregisters an installation on this machine
Public function bool

VerifyChunkData ( const FString& SearchPath,
const FString& OutputFile
)

 Searches a given directory for chunk and chunkdb files, and verifies their integrity uses the hashes in the files.

Classes

  Type Name Description
Public class FSimpleEvent Returns an event which fires when we start a new build install.  

Deprecated Functions

  Type Name Description
Public function Virtual bool Please use ChunkBuildDirectory instead.
Public function IBuildManifestPtr

MakeManifestFromJSON ( const FString& ManifestJSON
)

 MakeManifestFromJSON(const FString& ManifestJSON) has been deprecated. Please use MakeManifestFromData(const TArray& ManifestData) instead.
Public function IBuildInstallerRef

StartBuildInstall ( BuildPatchServices::FInstallerConfiguration Configuration,
FBuildPatchBoolManifestDelegate OnCompleteDelegate
)

 StartBuildInstall(BuildPatchServices::FInstallerConfiguration, FBuildPatchBoolManifestDelegate) has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed by IBuildInstaller::StartInstallation.
Public function IBuildInstallerPtr

StartBuildInstall ( IBuildManifestPtr CurrentManifest,
IBuildManifestPtr InstallManifest,
const FString& InstallDirectory,
FBuildPatchBoolManifestDelegate OnCompleteDelegate,
bool bIsRepair,
TSet< FString > InstallTags
)

 StartBuildInstall(IBuildManifestPtr, IBuildManifestPtr, const FString&, FBuildPatchBoolManifestDelegate, bool, TSet) has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed by IBuildInstaller::StartInstallation.
Public function IBuildInstallerPtr

StartBuildInstallStageOnly ( IBuildManifestPtr CurrentManifest,
IBuildManifestPtr InstallManifest,
const FString& InstallDirectory,
FBuildPatchBoolManifestDelegate OnCompleteDelegate,
bool bIsRepair,
TSet< FString > InstallTags
)

 StartBuildInstallStageOnly(IBuildManifestPtr, IBuildManifestPtr, const FString&, FBuildPatchBoolManifestDelegate, bool, TSet) has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed by IBuildInstaller::StartInstallation.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page