UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
BuildPatchServices::FMessageHandler Class Reference

#include <BuildPatchMessage.h>

+ Inheritance diagram for BuildPatchServices::FMessageHandler:

Public Member Functions

 FMessageHandler (EMessageRequests InMessageRequests)
 
virtual ~FMessageHandler ()=default
 
virtual void HandleMessage (const FGenericMessage &Message)
 
virtual void HandleMessage (const FChunkSourceEvent &Message)
 
virtual void HandleMessage (const FInstallationFileAction &Message)
 
virtual bool HandleRequest (const FChunkUriRequest &Request, TFunction< void(FChunkUriResponse)> OnResponse)
 
EMessageRequests GetMessageRequests () const
 

Detailed Description

Base class of a message handler, this should be inherited from and passed to an installer to receive messages that you want to handle.

Constructor & Destructor Documentation

◆ FMessageHandler()

BuildPatchServices::FMessageHandler::FMessageHandler ( EMessageRequests  InMessageRequests)
inline

◆ ~FMessageHandler()

virtual BuildPatchServices::FMessageHandler::~FMessageHandler ( )
virtualdefault

Member Function Documentation

◆ GetMessageRequests()

EMessageRequests BuildPatchServices::FMessageHandler::GetMessageRequests ( ) const
inline
Returns
the message request flags.

◆ HandleMessage() [1/3]

virtual void BuildPatchServices::FMessageHandler::HandleMessage ( const FChunkSourceEvent Message)
inlinevirtual

Handles a chunk source event message.

Parameters
MessageThe message to be handled.

◆ HandleMessage() [2/3]

virtual void BuildPatchServices::FMessageHandler::HandleMessage ( const FGenericMessage Message)
inlinevirtual

Handle generic information posting. This can be called from any thread and should not take appreciable time as it blocks further installation. See FGenericMessage for payload contents and types

◆ HandleMessage() [3/3]

virtual void BuildPatchServices::FMessageHandler::HandleMessage ( const FInstallationFileAction Message)
inlinevirtual

Handles an installation file action message.

Parameters
MessageThe message to be handled.

◆ HandleRequest()

virtual bool BuildPatchServices::FMessageHandler::HandleRequest ( const FChunkUriRequest Request,
TFunction< void(FChunkUriResponse)>  OnResponse 
)
inlinevirtual

Handles responding to a chunk Uri request

Parameters
RequestThe request for a chunk
OnResponseThe function to callback once the chunk has been found

Reimplemented in BuildPatchServices::FDefaultMessageHandler.


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