Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FRemoteConfigAsyncWorker Class Reference

#include <RemoteConfigIni.h>

+ Collaboration diagram for FRemoteConfigAsyncWorker:

Public Member Functions

 FRemoteConfigAsyncWorker (const TCHAR *InFilename, FRemoteConfigAsyncIOInfo &InIOInfo, FString *InContents, bool bInIsRead)
 
void DoWork ()
 
bool IsReadSuccess () const
 
FRemoteConfigAsyncIOInfoGetIOInfo ()
 
FORCEINLINE TStatId GetStatId () const
 
bool CanAbandon ()
 
void Abandon ()
 

Private Attributes

TCHAR Filename [1024]
 
FRemoteConfigAsyncIOInfo IOInfo
 
FString Contents
 
bool bIsRead
 

Detailed Description

Async task that handles the IO of a remote config file

Definition at line 55 of file RemoteConfigIni.h.

Constructor & Destructor Documentation

◆ FRemoteConfigAsyncWorker()

FRemoteConfigAsyncWorker::FRemoteConfigAsyncWorker ( const TCHAR * InFilename,
FRemoteConfigAsyncIOInfo & InIOInfo,
FString * InContents,
bool bInIsRead )

Constructor.

Member Function Documentation

◆ Abandon()

void FRemoteConfigAsyncWorker::Abandon ( )

Abandon routine

◆ CanAbandon()

bool FRemoteConfigAsyncWorker::CanAbandon ( )

Indicates to the thread pool that this task is abandonable.

◆ DoWork()

void FRemoteConfigAsyncWorker::DoWork ( )

Performs the actual IO operations.

◆ GetIOInfo()

FRemoteConfigAsyncIOInfo & FRemoteConfigAsyncWorker::GetIOInfo ( )

Returns the local IO info object

◆ GetStatId()

FORCEINLINE TStatId FRemoteConfigAsyncWorker::GetStatId ( ) const
inline

Definition at line 71 of file RemoteConfigIni.h.

◆ IsReadSuccess()

bool FRemoteConfigAsyncWorker::IsReadSuccess ( ) const

Returns true if the read IO operation succeeded.

Member Data Documentation

◆ bIsRead

bool FRemoteConfigAsyncWorker::bIsRead
private

true if read operation, false if write.

Definition at line 94 of file RemoteConfigIni.h.

◆ Contents

FString FRemoteConfigAsyncWorker::Contents
private

Contents to write out.

Definition at line 91 of file RemoteConfigIni.h.

◆ Filename

TCHAR FRemoteConfigAsyncWorker::Filename[1024]
private

Name of the remote config file.

Definition at line 85 of file RemoteConfigIni.h.

◆ IOInfo

FRemoteConfigAsyncIOInfo FRemoteConfigAsyncWorker::IOInfo
private

Local copy of the IO info object, for thread safety.

Definition at line 88 of file RemoteConfigIni.h.


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