Navigation
API > API/Developer > API/Developer/TraceServices
Analysis cache
Allows users of the system to create tracked fixed size blocks associated with a "cache id", created using a string. After creating block(s) users are free to write arbitrary data into them. Once all references to the block has been dropped the buffer is committed to persistent storage (e.g. cache file).
On consecutive analysis sessions the blocks can be retrieved using the cache id and the block index. Any block can be requested at any point in the session in any order.
Analysis is not thread safe and is designed to be used from the analysis thread only.
The container classes TraceServices::TCachedPagedArray or TraceServices::FCachedStringStore are provided as user facing abstractions on top of the cache.
| Name | IAnalysisCache |
| Type | class |
| Header File | /Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h |
| Include Path | #include "TraceServices/Model/AnalysisCache.h" |
Syntax
class IAnalysisCache
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAnalysisCache() |
TraceServices/Model/AnalysisCache.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BlockSizeBytes | uint64 | Block size in bytes | TraceServices/Model/AnalysisCache.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSharedBuffer CreateBlocks
(
FCacheId CacheId, |
Create blocks of tracked memory. | TraceServices/Model/AnalysisCache.h | |
FSharedBuffer GetBlocks
(
FCacheId CacheId, |
Load blocks into memory. | TraceServices/Model/AnalysisCache.h | |
FCacheId GetCacheId
(
const TCHAR* Name, |
Returns the unique id for a named entry. If the entry does not yet exists and new id is reserved. | TraceServices/Model/AnalysisCache.h | |
FMutableMemoryView GetUserData
(
FCacheId CacheId |
Gets a pointer to the user data a given cache id. | TraceServices/Model/AnalysisCache.h |