1. Epic GamesDeveloper
  3. IBuildPatchServicesModule

IBuildPatchServicesModule

Interface for the services manager.

API > API/Runtime > API/Runtime/BuildPatchServices

Interface for the services manager.

   
Name IBuildPatchServicesModule
Type class
Header File /Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildPatchServicesModule.h
Include Path #include "Interfaces/IBuildPatchServicesModule.h"

Syntax

class IBuildPatchServicesModule : public IModuleInterface

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IBuildPatchServicesModule()

 Virtual destructor. Interfaces/IBuildPatchServicesModule.h  

Classes

Name Remarks
FSimpleEvent Returns an event which fires when we start a new build install.

Functions

Public

Name Remarks Include Path Unreal Specifiers

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. Interfaces/IBuildPatchServicesModule.h  
Processes a Build directory to create chunks for new data and produce a manifest, saved to the provided cloud directory. Interfaces/IBuildPatchServicesModule.h  
Processes a Cloud Directory to identify and delete any orphaned chunks or files. Interfaces/IBuildPatchServicesModule.h  

IBuildInstallerRef CreateBuildInstaller ( BuildPatchServices::FBuildInstallerConfiguration Configuration,
FBuildPatchInstallerDelegate OnComplete
) const

 Factory providing construction of a build installer class. Interfaces/IBuildPatchServicesModule.h  

IBuildInstallerSharedContextRef CreateBuildInstallerSharedContext ( const TCHAR* DebugName
) const

 Factory providing construction of a build installer shared context class. Interfaces/IBuildPatchServicesModule.h  

IBuildInstallStreamerRef CreateBuildInstallStreamer ( BuildPatchServices::FBuildInstallStreamerConfiguration Configuration
)

 Factory providing construction of a build streamer class. Interfaces/IBuildPatchServicesModule.h  

BuildPatchServices::IBuildStatisticsRef CreateBuildStatistics ( const IBuildInstallerRef& Installer
) const

 Factory providing construction of a build statistics class. Interfaces/IBuildPatchServicesModule.h  

BuildPatchServices::IPatchDataEnumerationRef CreatePatchDataEnumeration ( BuildPatchServices::FPatchDataEnumerationConfiguration Configuration
) const

 Factory providing construction of a patch data enumeration class. Interfaces/IBuildPatchServicesModule.h  
Takes two manifests as input and outputs the details of the patch. Interfaces/IBuildPatchServicesModule.h  
Saves info for an enumeration of patch data referenced from an input file of known format, to a specified output file. Interfaces/IBuildPatchServicesModule.h  

virtual bool GenerateChunksManifestFromDirectory ( const BuildPatchServices::FGenerationConfiguration& Configuration
)

   Interfaces/IBuildPatchServicesModule.h  

TSet< FString > GetInstalledPrereqIds()

 Gets an array of prerequisite identifiers that are registered as installed on this system. Interfaces/IBuildPatchServicesModule.h  

const TArray< IBuildInstallerRef > & GetInstallers()

 Gets a list of currently active installers Interfaces/IBuildPatchServicesModule.h  

IBuildManifestPtr LoadManifestFromFile ( const FString& Filename
)

 Loads a Build Manifest from file and returns the interface Interfaces/IBuildPatchServicesModule.h  

IBuildManifestPtr MakeManifestFromData ( const TArray< uint8 >& ManifestData
)

 Constructs a Build Manifest from a data Interfaces/IBuildPatchServicesModule.h  

IBuildManifestPtr MakeManifestFromJSON ( const FString& ManifestJSON
)

   Interfaces/IBuildPatchServicesModule.h  

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. Interfaces/IBuildPatchServicesModule.h  

IBuildPatchServicesModule::FSimpleEvent TBaseMulticastDelegate_NoParams OnStartBuildInstall()

   Interfaces/IBuildPatchServicesModule.h  
Process a pair of manifests to produce additional delta data which reduces the patch directly between them. Interfaces/IBuildPatchServicesModule.h  
Packages data referenced by a manifest file into chunkdb files, supporting a maximum filesize per chunkdb. Interfaces/IBuildPatchServicesModule.h  

void RegisterAppInstallation ( IBuildManifestRef AppManifest,
const FString AppInstallDirectory
)

 Registers an installation on this machine. Interfaces/IBuildPatchServicesModule.h  

bool SaveManifestToFile ( const FString& Filename,
IBuildManifestRef Manifest
)

 Saves a Build Manifest to file Interfaces/IBuildPatchServicesModule.h  

void SetAnalyticsProvider ( TSharedPtr< IAnalyticsProvider > AnalyticsProvider
)

 Sets the Analytics provider that will be used to register errors with patch/build installs Interfaces/IBuildPatchServicesModule.h  

void SetBackupDirectory ( const FString& BackupDir
)

 Sets the backup directory where files that are being clobbered by repair/patch will be placed. Interfaces/IBuildPatchServicesModule.h  

void SetCloudDirectories ( TArray< FString > CloudDirs
)

 Sets the cloud directory list where chunks and manifests will be pulled from and saved to. Interfaces/IBuildPatchServicesModule.h  

void SetCloudDirectory ( FString CloudDir
)

 Sets the cloud directory where chunks and manifests will be pulled from and saved to. Interfaces/IBuildPatchServicesModule.h  

void SetStagingDirectory ( const FString& StagingDir
)

 Sets the directory used for staging intermediate files. Interfaces/IBuildPatchServicesModule.h  

IBuildInstallerRef StartBuildInstall ( BuildPatchServices::FInstallerConfiguration Configuration,
FBuildPatchBoolManifestDelegate OnCompleteDelegate
)

   Interfaces/IBuildPatchServicesModule.h  

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

   Interfaces/IBuildPatchServicesModule.h  

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

   Interfaces/IBuildPatchServicesModule.h  

bool UnregisterAppInstallation ( const FString AppInstallDirectory
)

 Unregisters an installation on this machine Interfaces/IBuildPatchServicesModule.h  

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. Interfaces/IBuildPatchServicesModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page