FAutomationWorkerModule Class Reference

#include <AutomationWorkerModule.h>

Inheritance diagram for FAutomationWorkerModule:

Public Member Functions
virtual void	StartupModule () override
virtual void	ShutdownModule () override
virtual bool	SupportsDynamicReloading () override
virtual void	Tick () override
Public Member Functions inherited from IAutomationWorkerModule
	DECLARE_DELEGATE_ThreeParams (FStopTestEvent, bool, FString, class FAutomationTestExecutionInfo const &)
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const

Protected Member Functions
bool	ExecuteLatentCommands ()
bool	ExecuteNetworkCommands ()
void	Initialize ()
void	ReportNetworkCommandComplete ()
void	ReportTestComplete ()
void	SendTests (const FMessageAddress &ControllerAddress)
void	SendMessage (FAutomationWorkerMessageBase *Message, UScriptStruct *TypeInfo, const FMessageAddress &ControllerAddress)
Protected Member Functions inherited from IAutomationWorkerModule
	IAutomationWorkerModule ()

Detailed Description

Implements the Automation Worker module.

Member Function Documentation

ExecuteLatentCommands()

bool FAutomationWorkerModule::ExecuteLatentCommands ( )

protected

Execute all latent commands and when complete send results message back to the automation controller.

ExecuteNetworkCommands()

bool FAutomationWorkerModule::ExecuteNetworkCommands ( )

protected

Execute all network commands and when complete send results message back to the automation controller.

Initialize()

void FAutomationWorkerModule::Initialize ( )

protected

Initializes the automation worker.

ReportNetworkCommandComplete()

void FAutomationWorkerModule::ReportNetworkCommandComplete ( )

protected

Network phase is complete (if there were any network commands). Send ping back to the controller.

ReportTestComplete()

void FAutomationWorkerModule::ReportTestComplete ( )

protected

Test is complete. Send results back to controller.

SendMessage()

void FAutomationWorkerModule::SendMessage ( FAutomationWorkerMessageBase *  Message, UScriptStruct *  TypeInfo, const FMessageAddress &  ControllerAddress  )

protected

Send a message in an unified way with passing correct Instance Id into the message we are going to send.

Parameters

Message	The message to be sent.
TypeInfo	The type information about the message to be sent.
ControllerAddress	The message address of the receiver.

SendTests()

void FAutomationWorkerModule::SendTests ( const FMessageAddress &  ControllerAddress )

protected

Send a list of all the tests supported by the worker

Parameters

ControllerAddress

The message address of the controller that requested the tests.

ShutdownModule()

void FAutomationWorkerModule::ShutdownModule ( )

overridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

StartupModule()

void FAutomationWorkerModule::StartupModule ( )

overridevirtual

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.

SupportsDynamicReloading()

bool FAutomationWorkerModule::SupportsDynamicReloading ( )

overridevirtual

Override this to set whether your module is allowed to be unloaded on the fly

Returns

Whether the module supports shutdown separate from the rest of the engine.

Reimplemented from IModuleInterface.

Tick()

void FAutomationWorkerModule::Tick ( )

overridevirtual

Ticks the automation worker module.

Implements IAutomationWorkerModule.

---

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

• Engine/Source/Runtime/AutomationWorker/Private/AutomationWorkerModule.h
• Engine/Source/Runtime/AutomationWorker/Private/AutomationWorkerModule.cpp