1. Epic GamesDeveloper
  3. FConcertDataStore

FConcertDataStore

Maintains a type-safe key/value map where the values are USTRUCT() structs serialized into a [FConcertDataStore_StoreValue](API\Plugins\ConcertSyncCore\FConcertDataStore_StoreValue).

API > API/Plugins > API/Plugins/ConcertSyncCore

Maintains a type-safe key/value map where the values are USTRUCT() structs serialized into a FConcertDataStore_StoreValue. Each key/value pair has a version, starting at 1 which incremented every times the value change.

The implementation is not thread safe. It is left to the user to synchronize access to the store.How to set up a value in the store.templatevoidMyClass::Store(constFName&Key,constT&Value){//WrapsTintoitscorrespondingUSTRUCT()ifthisisnotalreadyaUSTRUCT()consttypenameTConcertDataStoreType::StructType&StructWrappedValue=TConcertDataStoreType::AsStructType(Value);//Serializethevalue.FConcertSessionSerializedPayloadSerializedValue;SerializedValue.SetPayload(TConcertDataStoreType::StructType::StaticStruct(),&StructWrappedValue);//Storethevalueatversion1.DataStore.Store(Key,TConcertDataStoreType::GetFName(),SerializedValue);}

How to read a value from the store.templateTOptionalMyClass::Fetch(constFName&Key){FConcertDataStoreResultResult=DataStore.Fetch(Key,TConcertDataStoreType::GetFName());if(Result.Code==EConcertDataStoreResultCode::Fetched){returnResult.Value->DeserializeUnchecked();}returnTOptional();}

   
Name FConcertDataStore
Type class
Header File /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncCore/Source/ConcertSyncCore/Public/ConcertDataStore.h
Include Path #include "ConcertDataStore.h"

Syntax

class FConcertDataStore

Constructors

Name Remarks Include Path Unreal Specifiers

FConcertDataStore ( EUpdatePolicy InUpdatePolicy
)

 Construct the store. ConcertDataStore.h  

Enums

Public

Name Remarks
EUpdatePolicy Defines how the store updates an existing value.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
KeyValueMap TMap< FName, FConcertDataStoreValueRef > Maps keyName/keyValue. ConcertDataStore.h  
UpdatePolicy EUpdatePolicy Defines how the values are updated in the store. ConcertDataStore.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FConcertDataStoreResult Fetch ( const FName& Key,
const FName& TypeName
) const

 Looks up the specified key, if found and types match, fetches the corresponding value. ConcertDataStore.h  

FConcertDataStoreResult FetchOrAdd ( const FName& Key,
const FName& TypeName,
const FConcertSessionSerializedPayload& SerializedValue
)

 Searches the store for the specified key, if not found, adds a new key/value pair, otherwise, if the stored value type matches the initial value type, fetches the stored value. ConcertDataStore.h  

int32 GetSize()

 Returns the number of key/value pairs currently stored. ConcertDataStore.h  

TOptional< uint32 > GetVersion ( const FName& Key
) const

 Returns the version of the specified key if found. ConcertDataStore.h  

FConcertDataStoreResult Store ( const FName& Key,
const FName& TypeName,
const FConcertSessionSerializedPayload& SerializedValue,
const TOptional< uint32 >& Version
)

 Looks up the specified key, if it doesn't exist yet, adds new key/value pair, else, if the stored value type matches the specified value type, updates the value. ConcertDataStore.h  

void Visit ( const TFunctionRef< void(const FName&, const FConcertDataStore_StoreValue&)>& Visitor
) const

 Visits all the key/value currently stored. ConcertDataStore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page