FCrashUploadBase Class Reference

#include <CrashUpload.h>

Inheritance diagram for FCrashUploadBase:

Classes
struct	EUploadState

Public Member Functions
	FCrashUploadBase ()
virtual	~FCrashUploadBase ()
bool	IsEnabled () const
bool	IsUploadCalled () const
const FText &	GetStatusText () const
bool	IsFinished () const
bool	IsFinishedSuccessfully () const
void	Cancel ()

Static Public Member Functions
static bool	IsInitialized ()
static void	StaticInitialize (const FPlatformErrorReport &PlatformErrorReport)
static void	StaticShutdown ()

Protected Member Functions
void	SetCurrentState (EUploadState::Type InState)
void	AddReportToFailedList () const
void	CleanCrashReportDirectory (const FString &CrashReportDirectory)

Static Protected Member Functions
static bool	CompressData (const TArray< FString > &InPendingFiles, struct FCompressedData &OutCompressedData, TArray< uint8 > &OutPostData, struct FCompressedHeader *OptionalHeader=nullptr)
static const TCHAR *	ToString (EUploadState::Type InState)

Protected Attributes
bool	bUploadCalled
EUploadState::Type	State
FText	UploadStateText
EUploadState::Type	PauseState
TArray< FString >	PendingFiles
FPlatformErrorReport	ErrorReport
TArray< uint8 >	PostData
int32	PendingReportDirectoryIndex

Static Protected Attributes
static bool	bInitialized = false
static TArray< FString >	PendingReportDirectories
static TArray< FString >	FailedReportDirectories

Constructor & Destructor Documentation

FCrashUploadBase()

FCrashUploadBase::FCrashUploadBase

(

)

~FCrashUploadBase()

FCrashUploadBase::~FCrashUploadBase ( )

virtual

Member Function Documentation

AddReportToFailedList()

void FCrashUploadBase::AddReportToFailedList ( ) const

protected

When failed, add the report to a file list containing reports to upload next time

Cancel()

void FCrashUploadBase::Cancel ( )

inline

CleanCrashReportDirectory()

void FCrashUploadBase::CleanCrashReportDirectory ( const FString &  CrashReportDirectory )

protected

Removes crash report folder once submitted to the crash reporting backend, as to not fill up server -CleanCrashReports must be specified on the crash report client command line

CompressData()

bool FCrashUploadBase::CompressData ( const TArray< FString > &  InPendingFiles, struct FCompressedData &  OutCompressedData, TArray< uint8 > &  OutPostData, struct FCompressedHeader *  OptionalHeader = nullptr  )

staticprotected

GetStatusText()

const FText & FCrashUploadBase::GetStatusText ( ) const

inline

Provide progress or error information for the UI

IsEnabled()

bool FCrashUploadBase::IsEnabled ( ) const

inline

Is this uploader enabled or disabled?

IsFinished()

bool FCrashUploadBase::IsFinished ( ) const

inline

Determine whether the upload has finished (successfully or otherwise)

Returns

Whether the upload has finished

IsFinishedSuccessfully()

bool FCrashUploadBase::IsFinishedSuccessfully ( ) const

inline

Determine whether the upload has finished successfully.

IsInitialized()

static bool FCrashUploadBase::IsInitialized ( )

inlinestatic

IsUploadCalled()

bool FCrashUploadBase::IsUploadCalled ( ) const

inline

Has BeginUpload been called?

SetCurrentState()

void FCrashUploadBase::SetCurrentState ( EUploadState::Type  InState )

protected

Set the current state, also updating the status text where necessary

Parameters

State

State the uploader is now in

StaticInitialize()

void FCrashUploadBase::StaticInitialize ( const FPlatformErrorReport &  PlatformErrorReport )

static

StaticShutdown()

void FCrashUploadBase::StaticShutdown ( )

static

ToString()

const TCHAR * FCrashUploadBase::ToString ( EUploadState::Type  InState )

staticprotected

Get a string representation of the state, for logging purposes

Parameters

State

Value to stringize

Returns

Literal string value

Member Data Documentation

bInitialized

bool FCrashUploadBase::bInitialized = false

staticprotected

bUploadCalled

bool FCrashUploadBase::bUploadCalled

protected

ErrorReport

FPlatformErrorReport FCrashUploadBase::ErrorReport

protected

Error report being processed

FailedReportDirectories

TArray< FString > FCrashUploadBase::FailedReportDirectories

staticprotected

Full paths of reports from this run that did not upload

PauseState

EUploadState::Type FCrashUploadBase::PauseState

protected

State to pause at until confirmation has been received to continue

PendingFiles

TArray<FString> FCrashUploadBase::PendingFiles

protected

Full paths of files still to be uploaded

PendingReportDirectories

TArray< FString > FCrashUploadBase::PendingReportDirectories

staticprotected

Full paths of reports from previous runs still to be uploaded

PendingReportDirectoryIndex

int32 FCrashUploadBase::PendingReportDirectoryIndex

protected

PostData

TArray<uint8> FCrashUploadBase::PostData

protected

Buffer to keep reusing for file content and other messages

State

EUploadState::Type FCrashUploadBase::State

protected

What this class is currently doing

UploadStateText

FText FCrashUploadBase::UploadStateText

protected

Status of upload to display

---

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

• Engine/Source/Runtime/CrashReportCore/Public/CrashUpload.h
• Engine/Source/Runtime/CrashReportCore/Private/CrashUpload.cpp