IVirtualizationBackend

The interface to derive from to create a new backend implementation.

Unreal Engine C++ API Reference > Developer > Virtualization

References

   
Module Virtualization
Header /Engine/Source/Developer/Virtualization/Public/IVirtualizationBackend.h
Include #include "IVirtualizationBackend.h"

Syntax

class IVirtualizationBackend  

Remarks

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.

Constructors

Type Name Description
  IVirtualizationBackend ( FStringView InConfigName, FStringView InDebugName, EOperations InSupportedOperations )  

Destructors

Type Name Description
  ~IVirtualizationBackend ()  

Functions

Type Name Description
void Connect () Attempt to connect the backend to its services if not already connected.
bool DisableOperation ( EOperations Operation ) Disables operations on the backend
bool DoesPayloadExist ( const FIoHash& Id ) Checks if a payload exists in the backends storage.
bool DoPayloadsExist ( TArrayView< const FIoHash > Payload..., TArray< bool >& OutResults ) Checks if a number of payload exists in the backends storage.
const FStrin... GetConfigName () Returns a string containing the name of the backend as it appears in the virtualization graph in the config file
EConnectionS... GetConnectionStatus () Returns the connection status of the backend
const FStrin... GetDebugName () Returns a string that can be used to identify the backend for debugging and logging purposes
bool Initialize ( const FString& ConfigEntry ) This will be called during the setup of the backend hierarchy.
bool IsOperationDebugDisabled ( EOperations Operation ) Returns true if the given operation is disabled for debugging purposes
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.
bool PullData ( TArrayView< FPullRequest > Requests, EPullFlags Flags, FText& OutErrors ) The backend will attempt to retrieve the given payloads by what ever method the backend uses.
bool PushData ( TArrayView< FPushRequest > Requests, EPushFlags Flags )  
void SetOperationDebugState ( EOperations Operation, bool bIsDisabled ) Enable or disable the given operation based on the 'bIsDisabled' parameter

Enums

Type Name Description
Public enum EConnectionStatus Status of the backends connection to its services
Public enum EOperations Enum detailing which operations a backend can support
Public enum EPullFlags Specialize pulling behavior, IVirtualizationBackend::PullData
Public enum EPushFlags Specialize pushing behavior, IVirtualizationBackend::PushData

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library