1. Epic GamesDeveloper
  3. FAnalyticsPropertyStore

FAnalyticsPropertyStore

Implements a fast key/value database to store the metrics gathered to create the session summary event.

API > API/Runtime > API/Runtime/Analytics

Implements a fast key/value database to store the metrics gathered to create the session summary event. The store is buffered in memory until it is flushed to disk by calling Flush(). It is not designed to handle millions of key/value pairs, but rather a small subset that fits in memory. The implementation reserve disk space ahead of time and can usually perform in-place update. Setting or getting intrinsic types (int32, uint32, int64, uint64, float, double, bool as well as FDateTime) doesn't allocate memory. The string time is often updated in place if enough capacity was reserved. All store operations are thread safe and atomic from the caller perspective.

   
Name FAnalyticsPropertyStore
Type class
Header File /Engine/Source/Runtime/Analytics/Analytics/Public/AnalyticsPropertyStore.h
Include Path #include "AnalyticsPropertyStore.h"

Syntax

class FAnalyticsPropertyStore : public IAnalyticsPropertyStore

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers
  AnalyticsPropertyStore.h  
  AnalyticsPropertyStore.h  
Create an empty store. AnalyticsPropertyStore.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FAnalyticsPropertyStore()

   AnalyticsPropertyStore.h  

Classes

Name Remarks
FFlushWorker Helper task to persist the properties to disk in the background.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AsyncFlushDataCopy TArray< uint8 >   AnalyticsPropertyStore.h  
bFragmented bool   AnalyticsPropertyStore.h  
FileHandle TUniquePtr< IFileHandle >   AnalyticsPropertyStore.h  
FlushTask TUniquePtr< FAsyncTask< FFlushWorker > >   AnalyticsPropertyStore.h  
NameOffsetMap TMap< FString, uint32 >   AnalyticsPropertyStore.h  
StorageBuf TArray< uint8 >   AnalyticsPropertyStore.h  
StorageReader FMemoryReader   AnalyticsPropertyStore.h  
StorageWriter FMemoryWriter   AnalyticsPropertyStore.h  
StoreLock FCriticalSection   AnalyticsPropertyStore.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Create ( const FString& Pathname,
uint32 CapacityHint
)

 Create a new store, creating the file of the specified capacity and resetting the current state. AnalyticsPropertyStore.h  

bool IsValid()

 Returns true is the store was successfully created or loaded. AnalyticsPropertyStore.h  

bool Load ( const FString& Pathname
)

 Load the specified file in memory, resetting the current state. AnalyticsPropertyStore.h  

Overridden from IAnalyticsPropertyStore

Name Remarks Include Path Unreal Specifiers

virtual bool Contains ( const FString& Key
) const

 Returns true if the store contains the specified key. AnalyticsPropertyStore.h  

virtual bool Flush ( bool bAsync,
const FTimespan& Timeout
)

 Flushes cached values to disk. AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
FDateTime& OutValue
) const

   AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
bool& OutValue
) const

   AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
double& OutValue
) const

   AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
float& OutValue
) const

   AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
uint64& OutValue
) const

   AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
int64& OutValue
) const

   AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
uint32& OutValue
) const

   AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
int32& OutValue
) const

 Reads the specified key value from the store. AnalyticsPropertyStore.h  

virtual EStatusCode Get ( const FString& Key,
FString& OutValue
) const

   AnalyticsPropertyStore.h  

virtual uint32 Num()

 Returns the number of elements in the store. AnalyticsPropertyStore.h  

virtual bool Remove ( const FString& Key
)

 Removes the specified key from the store. AnalyticsPropertyStore.h  

virtual void RemoveAll()

 Removes all existing keys from the store. AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
int32 Value,
const TFunction< bool(const int32*, const int32&)>& ConditionFn
)

 Conditionnnaly adds or updates the specified key/value pair. AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
uint32 Value,
const TFunction< bool(const uint32*, const uint32&)>& ConditionFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
int64 Value,
const TFunction< bool(const int64*, const int64&)>& ConditionFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
uint64 Value,
const TFunction< bool(const uint64*, const uint64&)>& ConditionFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
bool Value
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
double Value,
const TFunction< bool(const double*, const double&)>& ConditionFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
const FString& Value,
uint32 CharCountCapacityHint
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
bool Value,
const TFunction< bool(const bool*, const bool&)>& ConditionFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
float Value,
const TFunction< bool(const float*, const float&)>& ConditionFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
const FDateTime& Value
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
uint32 Value
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
double Value
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
float Value
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
uint64 Value
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
int64 Value
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
const FString& Value,
const TFunction< bool(const FString*, const FString&)>& ConditionFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
int32 Value
)

 Adds or updates the specified key/value pair. AnalyticsPropertyStore.h  

virtual EStatusCode Set ( const FString& Key,
const FDateTime& Value,
const TFunction< bool(const FDateTime*, const FDateTime&)>& ConditionFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(FString&)>& UpdateFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(int32&)>& UpdateFn
)

 Updates an exiting value. AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(uint32&)>& UpdateFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(int64&)>& UpdateFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(uint64&)>& UpdateFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(float&)>& UpdateFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(double&)>& UpdateFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(bool&)>& UpdateFn
)

   AnalyticsPropertyStore.h  

virtual EStatusCode Update ( const FString& Key,
const TFunction< bool(FDateTime&)>& UpdateFn
)

   AnalyticsPropertyStore.h  

virtual void VisitAll ( const TFunction< void(FAnalyticsEventAttribute&&)>& VisitFn
) const

 Iterates the keys currently stored and invokes the visitor function for each key, converting the value to its string representation. AnalyticsPropertyStore.h  

Operators

Name Remarks Include Path Unreal Specifiers
  AnalyticsPropertyStore.h  
  AnalyticsPropertyStore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page