Navigation
API > API/Developer > API/Developer/Virtualization
The interface to derive from to create a new backend implementation.
Note that virtualization backends are instantiated FVirtualizationManager via IVirtualizationBackendFactory so each new backend derived from IVirtualizationBackend will also need a factory derived from IVirtualizationBackendFactory. You can either do this manually or use the helper macro 'UE_REGISTER_VIRTUALIZATION_BACKEND_FACTORY' to generate the code for you.
| Name | IVirtualizationBackend |
| Type | class |
| Header File | /Engine/Source/Developer/Virtualization/Public/IVirtualizationBackend.h |
| Include Path | #include "IVirtualizationBackend.h" |
Syntax
class IVirtualizationBackend
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IVirtualizationBackend
(
FStringView InConfigName, |
IVirtualizationBackend.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IVirtualizationBackend() |
IVirtualizationBackend.h |
Enums
Public
| Name | Remarks |
|---|---|
| EConnectionStatus | Status of the backends connection to its services |
| EOperations | Enum detailing which operations a backend can support |
| EPullFlags | Specialize pulling behavior, @See IVirtualizationBackend::PullData |
| EPushFlags | Specialize pushing behavior, @See IVirtualizationBackend::PushData |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ConfigName | FString | The name assigned to the backend by the virtualization graph | IVirtualizationBackend.h | |
| ConnectionMutex | UE::FMutex | Protects threaded access to 'ConnectionStatus' | IVirtualizationBackend.h | |
| ConnectionStatus | EConnectionStatus | The status of the connection to the backends service | IVirtualizationBackend.h | |
| DebugDisabledOperations | EOperations | The operations that have been disabled for debugging purposes | IVirtualizationBackend.h | |
| DebugName | FString | Combination of the backend type and the name used to create it in the virtualization graph | IVirtualizationBackend.h | |
| SupportedOperations | EOperations | The operations that this backend supports | IVirtualizationBackend.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Connect() |
IVirtualizationBackend.h | ||
bool DisableOperation
(
EOperations Operation |
Disables operations on the backend | IVirtualizationBackend.h | |
bool DoesPayloadExist
(
const FIoHash& Id |
Checks if a payload exists in the backends storage. | IVirtualizationBackend.h | |
virtual bool DoPayloadsExist
(
TArrayView< const FIoHash > PayloadIds, |
Checks if a number of payload exists in the backends storage. | IVirtualizationBackend.h | |
| IVirtualizationBackend.h | |||
| IVirtualizationBackend.h | |||
| IVirtualizationBackend.h | |||
const FString & GetConfigName() |
Returns a string containing the name of the backend as it appears in the virtualization graph in the config file | IVirtualizationBackend.h | |
| Returns the connection status of the backend | IVirtualizationBackend.h | ||
const FString & GetDebugName() |
Returns a string that can be used to identify the backend for debugging and logging purposes | IVirtualizationBackend.h | |
bool Initialize
(
const FString& ConfigEntry |
This will be called during the setup of the backend hierarchy. | IVirtualizationBackend.h | |
bool IsOperationDebugDisabled
(
EOperations Operation |
Returns true if the given operation is disabled for debugging purposes | IVirtualizationBackend.h | |
bool IsOperationSupported
(
EOperations Operation |
Returns true if the given operation is supported, this is set when the backend is created and should not change over it's life time. | IVirtualizationBackend.h | |
bool PullData
(
TArrayView< FPullRequest > Requests, |
The backend will attempt to retrieve the given payloads by what ever method the backend uses. | IVirtualizationBackend.h | |
bool PushData
(
TArrayView< FPushRequest > Requests, |
IVirtualizationBackend.h | ||
void SetOperationDebugState
(
EOperations Operation, |
Enable or disable the given operation based on the 'bIsDisabled' parameter | IVirtualizationBackend.h | |
EConnectionStatus TryConnect
(
bool bAllowReconnect |
Attempt to connect the backend to its services if not already connected. | IVirtualizationBackend.h |