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

#include <SecureHash.h>

+ Collaboration diagram for FAsyncSHAVerify:

Public Member Functions

 FAsyncSHAVerify (void *InBuffer, uint64 InBufferSize, bool bInShouldDeleteBuffer, const TCHAR *InPathname, bool bInIsUnfoundHashAnError)
 
void DoWork ()
 
bool CanAbandon ()
 
void Abandon ()
 
FORCEINLINE TStatId GetStatId () const
 

Protected Attributes

voidBuffer
 
uint64 BufferSize
 
uint8 Hash [20]
 
FString Pathname
 
bool bIsUnfoundHashAnError
 
bool bShouldDeleteBuffer
 

Detailed Description

Asynchronous SHA verification

Definition at line 419 of file SecureHash.h.

Constructor & Destructor Documentation

◆ FAsyncSHAVerify()

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

Constructor.

Parameters
InBufferBuffer of data to calculate has on. MUST be valid until this task completes (use Counter or pass ownership via bInShouldDeleteBuffer)
InBufferSizeSize of InBuffer
bInShouldDeleteBuffertrue 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
PathnamePathname to use to have the platform lookup the hash value
bInIsUnfoundHashAnErrortrue if failing to lookup the hash value results in a fail (only for Shipping PC)

Definition at line 452 of file SecureHash.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Function Documentation

◆ Abandon()

void FAsyncSHAVerify::Abandon ( )
inline

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

Definition at line 482 of file SecureHash.h.

+ Here is the call graph for this function:

◆ CanAbandon()

bool FAsyncSHAVerify::CanAbandon ( )
inline

Task API, return true to indicate that we can abandon

Definition at line 474 of file SecureHash.h.

◆ DoWork()

void FAsyncSHAVerify::DoWork ( )

Performs the async hash verification

◆ GetStatId()

FORCEINLINE TStatId FAsyncSHAVerify::GetStatId ( ) const
inline

Definition at line 491 of file SecureHash.h.

Member Data Documentation

◆ bIsUnfoundHashAnError

bool FAsyncSHAVerify::bIsUnfoundHashAnError
protected

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

Definition at line 435 of file SecureHash.h.

◆ bShouldDeleteBuffer

bool FAsyncSHAVerify::bShouldDeleteBuffer
protected

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

Definition at line 438 of file SecureHash.h.

◆ Buffer

void* FAsyncSHAVerify::Buffer
protected

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

Definition at line 423 of file SecureHash.h.

◆ BufferSize

uint64 FAsyncSHAVerify::BufferSize
protected

Size of Buffer

Definition at line 426 of file SecureHash.h.

◆ Hash

uint8 FAsyncSHAVerify::Hash[20]
protected

Hash to compare against

Definition at line 429 of file SecureHash.h.

◆ Pathname

FString FAsyncSHAVerify::Pathname
protected

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

Definition at line 432 of file SecureHash.h.


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