BuildPatchServices::FMessagePump Class Reference

Inheritance diagram for BuildPatchServices::FMessagePump:

Public Member Functions
virtual void	SendMessage (FChunkSourceEvent Message) override
virtual void	SendMessage (FInstallationFileAction Message) override
virtual void	SendMessage (FGenericMessage Message) override
virtual bool	SendRequest (FChunkUriRequest Request, TFunction< void(FChunkUriResponse)> OnResponse) override
virtual void	PumpMessages () override
virtual void	RegisterMessageHandler (FMessageHandler *MessageHandler) override
virtual void	UnregisterMessageHandler (FMessageHandler *MessageHandler) override
Public Member Functions inherited from BuildPatchServices::IMessagePump
virtual	~IMessagePump ()

Member Function Documentation

PumpMessages()

void BuildPatchServices::FMessagePump::PumpMessages ( )

overridevirtual

Dequeues received messages, pushing them to the provided handlers. NOTE: PumpMessages, RegisterMessageHandler, and UnregisterMessageHandler MUST all be called from the same thread.

Implements BuildPatchServices::IMessagePump.

RegisterMessageHandler()

void BuildPatchServices::FMessagePump::RegisterMessageHandler ( FMessageHandler *  MessageHandler )

overridevirtual

Registers a message handler.

Parameters

MessageHandler

Ptr to the message handler to add. Must not be null. NOTE: PumpMessages, RegisterMessageHandler, and UnregisterMessageHandler MUST all be called from the same thread.

Implements BuildPatchServices::IMessagePump.

SendMessage() [1/3]

void BuildPatchServices::FMessagePump::SendMessage ( FChunkSourceEvent  Message )

overridevirtual

Sends a chunk source event message.

Parameters

Message

The message to be sent.

Implements BuildPatchServices::IMessagePump.

SendMessage() [2/3]

void BuildPatchServices::FMessagePump::SendMessage ( FGenericMessage  Message )

overridevirtual

Implements BuildPatchServices::IMessagePump.

SendMessage() [3/3]

void BuildPatchServices::FMessagePump::SendMessage ( FInstallationFileAction  Message )

overridevirtual

Sends an installation file action message.

Parameters

Message

The message to be sent.

Implements BuildPatchServices::IMessagePump.

SendRequest()

bool BuildPatchServices::FMessagePump::SendRequest ( FChunkUriRequest  Request, TFunction< void(FChunkUriResponse)>  OnResponse  )

overridevirtual

Sends out a request to resolve the uri to the chunk location

Parameters

Request	Request for the chunk location
OnResponse	A delegate to call with the chunk location and any potential headers to add to the http request.

Note that while this function supports asynchronous processing, the calling code does not support cancelation of the requests under abort scenarios, potentially leading to crashes. As as result, incomplete shutdown of the installation requires waiting for all outstanding requests to return before shutdown can complete. For user initiated cancellations it is recommended that you abort any async uri request handling and call OnResponse with FChunkUriResponse::bFailed to true after calling CancelInstall(). This will prevent the default URL concatenation from occuring and allow the shutdown logic to complete in a timely fashion.

For internally initiated cancellations (due to errors) there's nothing to be done; shutdown just waits for the requests to all complete.

As a result, it's highly advisable to make this as immediate as possible, e.g. caching auth tokens up front before installation launch.

Implements BuildPatchServices::IMessagePump.

UnregisterMessageHandler()

void BuildPatchServices::FMessagePump::UnregisterMessageHandler ( FMessageHandler *  MessageHandler )

overridevirtual

Unregisters a message handler.

Parameters

MessageHandler

Ptr to the message handler to remove. NOTE: PumpMessages, RegisterMessageHandler, and UnregisterMessageHandler MUST all be called from the same thread.

Implements BuildPatchServices::IMessagePump.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Installer/MessagePump.cpp