#include <BulkData.h>

Inheritance diagram for FBulkDataBatchRequest:

Classes
class	FBatchBuilder

class	FBatchHandle

class	FScatterGatherBuilder

Public Member Functions
COREUOBJECT_API void	Wait ()

COREUOBJECT_API bool	WaitFor (uint32 Milliseconds)

COREUOBJECT_API bool	WaitFor (const FTimespan &WaitTime)

COREUOBJECT_API void	UpdatePriority (const EAsyncIOPriorityAndFlags Priority)

	FBulkDataRequest ()=default

	FBulkDataRequest (FBulkDataRequest &&)=default

	FBulkDataRequest (const FBulkDataRequest &)=delete

	FBulkDataRequest (FBulkDataRequest::IHandle *InHandle)

Public Member Functions inherited from FBulkDataRequest
	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 Member Functions
static FBatchBuilder	NewBatch (int32 MaxCount=-1)

static FScatterGatherBuilder	ScatterGather (int32 MaxCount=-1)

Additional Inherited Members
Public Types inherited from FBulkDataRequest
enum class	EStatus : uint32 { None , Pending , Ok , Cancelled , Error }

using	FCompletionCallback = TFunction< void(EStatus)>

Static Public Attributes inherited from FBulkDataRequest
static constexpr EAsyncIOPriorityAndFlags	DefaultPriority = AIOP_BelowNormal

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

Protected Attributes inherited from FBulkDataRequest
TRefCountPtr< IHandle >	Handle

Detailed Description

A batch request is a handle to one or more I/O requests.

The batch request is kept alive by passing in handles when appending read operations or by passing in a handle when issuing the batch. At least one handle needs to be passed in. The last handle will block until the entire batch is complete before being released.

Member Function Documentation

◆ FBulkDataRequest() [1/4]

FBulkDataRequest::FBulkDataRequest ( )

default

Constructs a new handle to bulk data request.

◆ FBulkDataRequest() [2/4]

FBulkDataRequest::FBulkDataRequest ( const FBulkDataRequest & )

delete

Not copy constructable or copy assignable.

◆ FBulkDataRequest() [3/4]

FBulkDataRequest::FBulkDataRequest ( FBulkDataRequest && )

default

Moves ownership from an invalid or pending request.

◆ FBulkDataRequest() [4/4]

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

inline

◆ NewBatch()

static FBatchBuilder FBulkDataBatchRequest::NewBatch ( int32 MaxCount = -1 )

inlinestatic

Returns a request builder that dispatches one or more I/O requests in a single batch.

◆ ScatterGather()

static FScatterGatherBuilder FBulkDataBatchRequest::ScatterGather ( int32 MaxCount = -1 )

inlinestatic

Returns a request builder that reads one or more bulk data into a single I/O buffer.

◆ UpdatePriority()

void FBulkDataBatchRequest::UpdatePriority ( const EAsyncIOPriorityAndFlags Priority )

Adjusts the priority of the request(s) (if possible).

Parameters

Priority The new priority to use

◆ Wait()

void FBulkDataBatchRequest::Wait ( )

Blocks the calling thread until the request is completed. Waiting on an invalid request will immediately return.

◆ WaitFor() [1/2]

bool FBulkDataBatchRequest::WaitFor ( const FTimespan & WaitTime )

Waits the specified amount of time for the request to be completed.

Returns: True if the request was completed before the wait time elapsed, otherwise false. Waiting on an invalid request returns false.

◆ WaitFor() [2/2]

bool FBulkDataBatchRequest::WaitFor ( uint32 Milliseconds )

Waits the specified amount of time in milliseconds for the request to be completed.

Returns: True if the request was completed before the wait time elapsed, otherwise false. Waiting on an invalid request returns false.

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

Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h
Engine/Source/Runtime/CoreUObject/Private/Serialization/BulkDataStreaming.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members