Navigation
API > API/Runtime > API/Runtime/Analytics > API/Runtime/Analytics/FAnalyticsPropertyStore
Description
Flushes cached values to disk. Only one thread can flush at a time, causing possible latency if a flush is alreary happenning. Store.Flush();//Flushinthecallingthread,blockuntilallthreadshasfinishedflushing.Store.Flush(false,FTimespan::Zero());//Flushinthecallingthreadifpossible,returnimmediatedlyifanotherthreadisalreadyflushing.Store.Flush(true,FTimespan::Zero());//Flushinabackgroudthreadifnootherthreadisflushing,returnimmediatedlyifanotherflushingtaskisrunning.Store.Flush(true);//Flushinabackgroundthread,mightblockifathreadisalreadyflushing.(Itdoesn'tqueueseveraltasks).
Virtual Inheritance
- IAnalyticsPropertyStore::Flush → FAnalyticsPropertyStore::Flush
| Name | Flush |
| Type | function |
| Header File | /Engine/Source/Runtime/Analytics/Analytics/Public/AnalyticsPropertyStore.h |
| Include Path | #include "AnalyticsPropertyStore.h" |
| Source | /Engine/Source/Runtime/Analytics/Analytics/Private/AnalyticsPropertyStore.cpp |
virtual bool Flush
(
bool bAsync,
const FTimespan & Timeout
)
True if the flush was executed (synchronous) or scheduled (asynchronous), false if the operation timed out.
Parameters
| Name | Remarks |
|---|---|
| bAsync | Whether the data in flushed in a background thread or in the calling thread. |
| Timeout | Maximum time to wait before the flush starts (synchronous) or get scheduled (asynchronous). FTimespan::Zero() means no waiting. |