FAsyncSHAVerify Class Reference

#include <SecureHash.h>

Public Member Functions
	FAsyncSHAVerify (void *InBuffer, uint64 InBufferSize, bool bInShouldDeleteBuffer, const TCHAR *InPathname, bool bInIsUnfoundHashAnError)
CORE_API void	DoWork ()
bool	CanAbandon ()
void	Abandon ()
UE_FORCEINLINE_HINT TStatId	GetStatId () const

Protected Attributes
void *	Buffer
uint64	BufferSize
uint8	Hash [20]
FString	Pathname
bool	bIsUnfoundHashAnError
bool	bShouldDeleteBuffer

Detailed Description

Asynchronous SHA verification

Constructor & Destructor Documentation

FAsyncSHAVerify()

FAsyncSHAVerify::FAsyncSHAVerify ( void *  InBuffer, uint64  InBufferSize, bool  bInShouldDeleteBuffer, const TCHAR *  InPathname, bool  bInIsUnfoundHashAnError  )

inline

Constructor.

Parameters

InBuffer	Buffer of data to calculate has on. MUST be valid until this task completes (use Counter or pass ownership via bInShouldDeleteBuffer)
InBufferSize	Size of InBuffer
bInShouldDeleteBuffer	true if this task should FMemory::Free InBuffer on completion of the verification. Useful for a fire & forget verification NOTE: If you pass ownership to the task MAKE SURE you are done using the buffer as it could go away at ANY TIME
Pathname	Pathname to use to have the platform lookup the hash value
bInIsUnfoundHashAnError	true if failing to lookup the hash value results in a fail (only for Shipping PC)

Member Function Documentation

Abandon()

void FAsyncSHAVerify::Abandon ( )

inline

Abandon task, deletes the buffer if that is what was requested

CanAbandon()

bool FAsyncSHAVerify::CanAbandon ( )

inline

Task API, return true to indicate that we can abandon

DoWork()

void FAsyncSHAVerify::DoWork

(

)

Performs the async hash verification

GetStatId()

UE_FORCEINLINE_HINT TStatId FAsyncSHAVerify::GetStatId ( ) const

inline

Member Data Documentation

bIsUnfoundHashAnError

bool FAsyncSHAVerify::bIsUnfoundHashAnError

protected

If this is true, and looking up the hash by filename fails, this will abort execution

bShouldDeleteBuffer

bool FAsyncSHAVerify::bShouldDeleteBuffer

protected

Should this class delete the buffer memory when verification is complete?

Buffer

void* FAsyncSHAVerify::Buffer

protected

Buffer to run the has on. This class can take ownership of the buffer is bShouldDeleteBuffer is true

BufferSize

uint64 FAsyncSHAVerify::BufferSize

protected

Size of Buffer

Hash

uint8 FAsyncSHAVerify::Hash[20]

protected

Hash to compare against

Pathname

FString FAsyncSHAVerify::Pathname

protected

Filename to lookup hash value (can be empty if hash was passed to constructor)

---

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

• Engine/Source/Runtime/Core/Public/Misc/SecureHash.h
• Engine/Source/Runtime/Core/Private/Misc/SecureHash.cpp