FBulkDataRequest Class Reference

#include <BulkData.h>

Inheritance diagram for FBulkDataRequest:

Classes
class	IHandle

Public Types
enum class	EStatus : uint32 {   None , Pending , Ok , Cancelled ,   Error }
using	FCompletionCallback = TFunction< void(EStatus)>

Public Member Functions
	FBulkDataRequest ()=default
	~FBulkDataRequest ()=default
	FBulkDataRequest (FBulkDataRequest &&)=default
FBulkDataRequest &	operator= (FBulkDataRequest &&)=default
	FBulkDataRequest (const FBulkDataRequest &)=delete
FBulkDataRequest &	operator= (const FBulkDataRequest &)=delete
EStatus	GetStatus () const
bool	IsNone () const
bool	IsPending () const
bool	IsOk () const
bool	IsCompleted () const
void	Cancel ()
void	Reset ()

Static Public Attributes
static constexpr EAsyncIOPriorityAndFlags	DefaultPriority = AIOP_BelowNormal

Protected Member Functions
	FBulkDataRequest (FBulkDataRequest::IHandle *InHandle)

Protected Attributes
TRefCountPtr< IHandle >	Handle

Friends
class	FHandleBase
class	FChunkBatchReadRequest
class	FBulkDataBatchRequest

Detailed Description

Handle to a bulk data I/O request.

Member Typedef Documentation

FCompletionCallback

using FBulkDataRequest::FCompletionCallback = TFunction<void(EStatus)>

Completion callback.

Member Enumeration Documentation

EStatus

enum class FBulkDataRequest::EStatus : uint32

strong

Bulk data request status.

Enumerator
None	The request hasn't been issued.
Pending	The request is pending.
Ok	The request has been completed successfully.
Cancelled	The request was cancelled.
Error	An error occured while issuing the request.

Constructor & Destructor Documentation

FBulkDataRequest() [1/4]

FBulkDataRequest::FBulkDataRequest ( )

default

Constructs a new handle to bulk data request.

~FBulkDataRequest()

FBulkDataRequest::~FBulkDataRequest ( )

default

Destructor, cancels and waits for any pending requests.

FBulkDataRequest() [2/4]

FBulkDataRequest::FBulkDataRequest ( FBulkDataRequest &&  )

default

Moves ownership from an invalid or pending request.

FBulkDataRequest() [3/4]

FBulkDataRequest::FBulkDataRequest ( const FBulkDataRequest &  )

delete

Not copy constructable or copy assignable.

FBulkDataRequest() [4/4]

FBulkDataRequest::FBulkDataRequest ( FBulkDataRequest::IHandle *  InHandle )

inlineprotected

Member Function Documentation

Cancel()

void FBulkDataRequest::Cancel ( )

inline

Cancel the pending request. Cancelling an invalid request will immediately return.

GetStatus()

EStatus FBulkDataRequest::GetStatus ( ) const

inline

Returns current status of the request.

IsCompleted()

bool FBulkDataRequest::IsCompleted ( ) const

inline

Returns whether the request has been completed.

IsNone()

bool FBulkDataRequest::IsNone ( ) const

inline

Returns whether the request is associated with a pending or completed request.

IsOk()

bool FBulkDataRequest::IsOk ( ) const

inline

Returns whether the request completed successfully.

IsPending()

bool FBulkDataRequest::IsPending ( ) const

inline

Returns whether the request is pending.

operator=() [1/2]

FBulkDataRequest & FBulkDataRequest::operator= ( const FBulkDataRequest &  )

delete

operator=() [2/2]

FBulkDataRequest & FBulkDataRequest::operator= ( FBulkDataRequest &&  )

default

Reset()

void FBulkDataRequest::Reset ( )

inline

Reset the request handle to an invalid state. Will cancel and wait if the request is not completed.

Friends And Related Symbol Documentation

FBulkDataBatchRequest

friend class FBulkDataBatchRequest

friend

FChunkBatchReadRequest

friend class FChunkBatchReadRequest

friend

FHandleBase

friend class FHandleBase

friend

Member Data Documentation

DefaultPriority

constexpr EAsyncIOPriorityAndFlags FBulkDataRequest::DefaultPriority = AIOP_BelowNormal

staticconstexpr

Default bulk data I/O request priority.

Handle

TRefCountPtr<IHandle> FBulkDataRequest::Handle

protected

---

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

• Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h