FRemoteConfigAsyncTaskManager Class Reference

#include <RemoteConfigIni.h>

Collaboration diagram for FRemoteConfigAsyncTaskManager:

Public Member Functions
void	Tick ()
bool	StartTask (const TCHAR *InFilename, const TCHAR *RemotePath, FRemoteConfigAsyncIOInfo &InIOInfo, FString *InContents, bool bInIsRead)
bool	IsFinished (const TCHAR *InFilename)
bool	AreAllTasksFinished (bool bDoRemoval)
bool	GetReadData (const TCHAR *InFilename, FRemoteConfigAsyncIOInfo &OutIOInfo)

Static Public Member Functions
static FRemoteConfigAsyncTaskManager *	Get ()

Private Member Functions
bool	FindCachedWriteTask (const TCHAR *InFilename, bool bCompareContents, const TCHAR *InContents)

Private Attributes
TMap< FString, FAsyncTask< FRemoteConfigAsyncWorker > * >	PendingTasks
TArray< FRemoteConfigAsyncCachedWriteTask >	CachedWriteTasks
FCriticalSection	SynchronizationObject

Detailed Description

Manages async IO tasks for remote config files

Definition at line 118 of file RemoteConfigIni.h.

Member Function Documentation

AreAllTasksFinished()

bool FRemoteConfigAsyncTaskManager::AreAllTasksFinished

(

bool

bDoRemoval

)

Returns true if the all tasks in the queue have completed (or, if the queue is empty).

FindCachedWriteTask()

bool FRemoteConfigAsyncTaskManager::FindCachedWriteTask ( const TCHAR * InFilename, bool bCompareContents, const TCHAR * InContents )

private

Returns true if file exists in the cached task list.

Get()

static FRemoteConfigAsyncTaskManager * FRemoteConfigAsyncTaskManager::Get ( )

static

Returns a reference to the global FRemoteConfigAsyncTaskManager object.

GetReadData()

bool FRemoteConfigAsyncTaskManager::GetReadData	(	const TCHAR *	InFilename,
		FRemoteConfigAsyncIOInfo &	OutIOInfo )

Safely retrieve the read data from the completed async task.

IsFinished()

bool FRemoteConfigAsyncTaskManager::IsFinished

(

const TCHAR *

InFilename

)

Returns true if the task has completed

StartTask()

bool FRemoteConfigAsyncTaskManager::StartTask	(	const TCHAR *	InFilename,
		const TCHAR *	RemotePath,
		FRemoteConfigAsyncIOInfo &	InIOInfo,
		FString *	InContents,
		bool	bInIsRead )

Add an async IO task to the queue and kick it off.

Tick()

void FRemoteConfigAsyncTaskManager::Tick

(

)

Handles cached write tasks.

Member Data Documentation

CachedWriteTasks

TArray<FRemoteConfigAsyncCachedWriteTask> FRemoteConfigAsyncTaskManager::CachedWriteTasks

private

List of cached off write tasks waiting for currently pending tasks to complete.

Definition at line 149 of file RemoteConfigIni.h.

PendingTasks

TMap<FString, FAsyncTask<FRemoteConfigAsyncWorker>* > FRemoteConfigAsyncTaskManager::PendingTasks

private

List of pending async IO operations

Definition at line 146 of file RemoteConfigIni.h.

SynchronizationObject

FCriticalSection FRemoteConfigAsyncTaskManager::SynchronizationObject

private

Object used for synchronization via a scoped lock.

Definition at line 152 of file RemoteConfigIni.h.

---

The documentation for this class was generated from the following file:

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/RemoteConfigIni.h