Navigation
API > API/Plugins > API/Plugins/InterchangeDispatcher
Handle a list of tasks, and a set of external workers to consume them.
| Name | FInterchangeDispatcher |
| Type | class |
| Header File | /Engine/Plugins/Interchange/Runtime/Source/Dispatcher/Public/InterchangeDispatcher.h |
| Include Path | #include "InterchangeDispatcher.h" |
Syntax
class FInterchangeDispatcher
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInterchangeDispatcher
(
const FString& InResultFolder, |
If WorkerCount == 0, the dispatcher will determine the number of worker processes to start based on main application's workload, threads and memory wise. | InterchangeDispatcher.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FInterchangeDispatcher() |
InterchangeDispatcher.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CompletedTaskCount | int32 | InterchangeDispatcher.h | ||
| InterchangeWorkerFatalError | FString | InterchangeDispatcher.h | ||
| NextTaskIndex | int32 | InterchangeDispatcher.h | ||
| TaskPoolCriticalSection | FCriticalSection | Tasks. | InterchangeDispatcher.h | |
| WorkerApplicationPath | FString | Workers. | InterchangeDispatcher.h | |
| WorkerHandler_Deprecated | TUniquePtr< FInterchangeWorkerHandler > | InterchangeDispatcher.h | ||
| WorkerHandlers | TArray< TUniquePtr< FInterchangeWorkerHandler > > | InterchangeDispatcher.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| InterchangeDispatcher.h | |||
| InterchangeDispatcher.h | |||
FString GetInterchangeWorkerFatalError() |
InterchangeDispatcher.h | ||
| InterchangeDispatcher.h | |||
void GetTaskState
(
int32 TaskIndex, |
InterchangeDispatcher.h | ||
void GetTaskState
(
int32 TaskIndex, |
InterchangeDispatcher.h | ||
virtual const TCHAR * GetWorkerApplicationName() |
InterchangeDispatcher.h | ||
const FString & GetWorkerApplicationPath() |
InterchangeDispatcher.h | ||
bool IsOver() |
InterchangeDispatcher.h | ||
bool IsValid() |
InterchangeDispatcher.h | ||
void SetInterchangeWorkerFatalError
(
FString& ErrorMessage |
InterchangeDispatcher.h | ||
void SetTaskState
(
int32 TaskIndex, |
InterchangeDispatcher.h | ||
void StartProcess() |
InterchangeDispatcher.h | ||
virtual void StopProcess
(
bool bBlockUntilTerminated |
InterchangeDispatcher.h | ||
virtual void TerminateProcess() |
InterchangeDispatcher.h | ||
void WaitAllTaskToCompleteExecution() |
InterchangeDispatcher.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CloseHandlers() |
InterchangeDispatcher.h |