Navigation
API > API/Developer > API/Developer/UbaCoordinatorHorde
UBA/Horde configuration structure. This is meant to match the C# version UnrealBuildTool.UnrealBuildAcceleratorHordeConfig.
| Name | FUbaHordeConfig |
| Type | class |
| Header File | /Engine/Source/Developer/UbaCoordinatorHorde/Public/UbaHordeConfig.h |
| Include Path | #include "UbaHordeConfig.h" |
Syntax
class FUbaHordeConfig
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ClusterAuto | const TCHAR * | UbaHordeConfig.h | |
| ClusterDefault | const TCHAR * | UbaHordeConfig.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHordeAllowWine | bool | Allow use of POSIX/Wine. | UbaHordeConfig.h | |
| bIsProviderEnabled | bool | Specifies whether UBA/Horde is enabled for the current session. By default disabled. | UbaHordeConfig.h | |
| DefaultHordePool | FString | UbaHordeConfig.h | ||
| HordeCluster | FString | Compute cluster ID to use in Horde. | UbaHordeConfig.h | |
| HordeCondition | FString | Requirements for the Horde agent to assign. | UbaHordeConfig.h | |
| HordeConnectionMode | EUbaHordeConnectionMode | Specifies how to connect to the remote machine. Relay mode implies encrypted connections. | UbaHordeConfig.h | |
| HordeEnabled | EUbaHordeEnabledMode | UbaHordeConfig.h | ||
| HordeEncryption | EUbaHordeEncryption | Specifies transport layer encryption. Currently only AES encryption is supported. | UbaHordeConfig.h | |
| HordeHost | FString | Which IP address UBA server should assign to agents. | UbaHordeConfig.h | |
| HordeMaxCores | int32 | Maxmium number of CPU cores allowed to be used by build session. | UbaHordeConfig.h | |
| HordePool | FString | Horde pool name. | UbaHordeConfig.h | |
| HordeServer | FString | URI of the Horde server. | UbaHordeConfig.h | |
| HordeToken | FString | Authentication token for the Horde server. | UbaHordeConfig.h | |
| LinuxHordePool | FString | UbaHordeConfig.h | ||
| MacHordePool | FString | UbaHordeConfig.h | ||
| MaxParallelActions | int32 | Maximum number of local CPU cores allowed to be used by build session. | UbaHordeConfig.h | |
| OverrideHordePool | FString | UbaHordeConfig.h | ||
| Provider | FString | Selected Horde provider, e.g. "Uba.Provider.Horde" by default | UbaHordeConfig.h | |
| UbaSentryUrl | FString | Optional sentry URL to send UBA data to. | UbaHordeConfig.h | |
| WindowsHordePool | FString | UbaHordeConfig.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FString & GetHordePool() |
Returns the active Horde pool depending on override settings and current desktop platform. | UbaHordeConfig.h | |
bool IsHordeEnabled() |
UbaHordeConfig.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FUbaHordeConfig & Get() |
Returns the global UBA/Horde configuration and initializes it from a list of XML files on the first call. | UbaHordeConfig.h |