FDerivedDataBackendInterface

Interface for cache server backends.

Windows
MacOS
Linux

References

Module

DerivedDataCache

Header

/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBackendInterface.h

Include

#include "DerivedDataBackendInterface.h"

Syntax

class FDerivedDataBackendInterface

Remarks

Interface for cache server backends. The entire API should be callable from any thread (except the singleton can be assumed to be called at least once before concurrent access).

Destructors

Functions

Name Description

Public function Virtual

bool

 

BackfillLowerCacheLevels()

Return true if hits on this cache should propagate to lower cache level.

Public function

bool

 

CachedDataProbablyExists

(
    const TCHAR* CacheKey
)

Synchronous test for the existence of a cache item

Public function

void

 

GatherUsageStats

(
    TMap< FString, FDerivedDataCacheUsa...,
    FString&& GraphPath
)

Retrieve usage stats for this backend.

Public function

bool

 

GetCachedData

(
    const TCHAR* CacheKey,
    TArray< uint8 >& OutData
)

Synchronous retrieve of a cache item

Public function Const

FString

 

GetName()

Return a name for this interface

Public function

bool

 

IsWritable()

Return true if this cache is writable

Public function

void

 

PutCachedData

(
    const TCHAR* CacheKey,
    TArray< uint8 >& InData,
    bool bPutEvenIfExists
)

Asynchronous, fire-and-forget placement of a cache item

Public function

void

 

RemoveCachedData

(
    const TCHAR* CacheKey,
    bool bTransient
)

Remove data from cache (used in the event that corruption is detected at a higher level and possibly house keeping)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss