FRemoteConfig Class Reference

#include <RemoteConfigIni.h>

Collaboration diagram for FRemoteConfig:

Public Member Functions
	FRemoteConfig ()
bool	IsRemoteFile (const TCHAR *Filename)
bool	ShouldReadRemoteFile (const TCHAR *Filename)
FRemoteConfigAsyncIOInfo *	FindConfig (const TCHAR *Filename)
bool	IsFinished (const TCHAR *InFilename)
bool	Read (const TCHAR *GeneratedIniFile, const TCHAR *DefaultIniFile)
bool	Write (const TCHAR *Filename, FString &Contents)
void	FinishRead (const TCHAR *Filename)

Static Public Member Functions
static FRemoteConfig *	Get ()
static void	Flush ()
static FString	ReplaceIniCharWithSpecialChar (const FString &Str)
static FString	ReplaceIniSpecialCharWithChar (const FString &Str)

Private Member Functions
FString	GenerateRemotePath (const TCHAR *Filename)

Private Attributes
TMap< FString, FRemoteConfigAsyncIOInfo >	ConfigBuffers
float	Timeout
bool	bIsEnabled
bool	bHasCachedFilenames
TArray< FString >	CachedFileNames

Detailed Description

Manages remote config files.

Definition at line 159 of file RemoteConfigIni.h.

Constructor & Destructor Documentation

FRemoteConfig()

FRemoteConfig::FRemoteConfig

(

)

Constructor

Member Function Documentation

FindConfig()

FRemoteConfigAsyncIOInfo * FRemoteConfig::FindConfig

(

const TCHAR *

Filename

)

Simple accessor function.

FinishRead()

void FRemoteConfig::FinishRead

(

const TCHAR *

Filename

)

Waits on the async read if it hasn't finished yet... times out if the operation has taken too long.

Flush()

static void FRemoteConfig::Flush ( )

static

Finishes all pending async IO tasks.

GenerateRemotePath()

FString FRemoteConfig::GenerateRemotePath ( const TCHAR * Filename )

private

Creates the remote path string for the specified file.

Get()

static FRemoteConfig * FRemoteConfig::Get ( )

static

Returns a reference to the global FRemoteConfig object.

IsFinished()

bool FRemoteConfig::IsFinished

(

const TCHAR *

InFilename

)

Returns true if the task has completed.

IsRemoteFile()

bool FRemoteConfig::IsRemoteFile

(

const TCHAR *

Filename

)

Returns true if the specified config file has been flagged as being remote.

Read()

bool FRemoteConfig::Read	(	const TCHAR *	GeneratedIniFile,
		const TCHAR *	DefaultIniFile )

Queues up a new async task for reading a remote config file.

ReplaceIniCharWithSpecialChar()

static FString FRemoteConfig::ReplaceIniCharWithSpecialChar ( const FString & Str )

static

ReplaceIniSpecialCharWithChar()

static FString FRemoteConfig::ReplaceIniSpecialCharWithChar ( const FString & Str )

static

ShouldReadRemoteFile()

bool FRemoteConfig::ShouldReadRemoteFile

(

const TCHAR *

Filename

)

Returns true if the specified file is remote and still needs to be read.

Write()

bool FRemoteConfig::Write	(	const TCHAR *	Filename,
		FString &	Contents )

Queues up a new async task for writing a remote config file.

Member Data Documentation

bHasCachedFilenames

bool FRemoteConfig::bHasCachedFilenames

private

true if the list of desired remote files has been filled out.

Definition at line 214 of file RemoteConfigIni.h.

bIsEnabled

bool FRemoteConfig::bIsEnabled

private

If true, remote ops are allowed.

Definition at line 211 of file RemoteConfigIni.h.

CachedFileNames

TArray<FString> FRemoteConfig::CachedFileNames

private

List of desired remote files.

Definition at line 217 of file RemoteConfigIni.h.

ConfigBuffers

TMap<FString, FRemoteConfigAsyncIOInfo> FRemoteConfig::ConfigBuffers

private

List of remote config file info.

Definition at line 205 of file RemoteConfigIni.h.

Timeout

float FRemoteConfig::Timeout

private

Async IO operation timeout.

Definition at line 208 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