IAsyncReadRequest

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Async/AsyncFileHandle.h

Include

#include "Async/AsyncFileHandle.h"

Syntax

class IAsyncReadRequest

Variables

Name Description

Protected variable

union IAsyncRea...

 

@50

Protected variable

bool

 

bCanceled

Protected variable

bool

 

bCompleteAndCallbackCalled

Protected variable

bool

 

bCompleteSync

Protected variable

bool

 

bDataIsReady

Protected variable

const bool

 

bSizeRequest

Protected variable

const bool

 

bUserSuppliedMemory

Protected variable

FAsyncFileCallB...

 

Callback

Public variable

uint8 *

 

Memory

Public variable

PTRINT

 

Size

Constructors

Name Description

Public function

IAsyncReadRequest

(
    FAsyncFileCallBack* InCallback,
    bool bInSizeRequest,
    uint8* UserSuppliedMemory
)

Destructors

Name Description

Public function Virtual

~IAsyncReadRequest()

Not legal to destroy the request until it is complete.

Functions

Name Description

Public function

void

 

Cancel()

Cancel the request. This is a non-blocking async call and so does not ensure completion!

Protected function

void

 

CancelImpl()

Cancel the request. This is a non-blocking async call and so does not ensure completion!

Public function

uint8 *

 

GetReadResults()

Return the bytes of a completed read request. Not legal to call unless the request is complete.

Public function

int64

 

GetSizeResults()

Return the size of a completed size request. Not legal to call unless the request is complete.

Public function

bool

 

PollCompletion()

Nonblocking poll of the state of completion.

Protected function

void

 

SetAllComplete()

Protected function

void

 

SetComplete()

Protected function

void

 

SetDataComplete()

Public function

bool

 

WaitCompletion

(
    float TimeLimitSeconds
)

Waits for the request to complete, but not longer than the given time limit

Protected function

void

 

WaitCompletionImpl

(
    float TimeLimitSeconds
)

Waits for the request to complete, but not longer than the given time limit

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback