FBulkDataBatchRequest::FBatchBuilder Class Reference

#include <BulkData.h>

Inherits FBulkDataBatchRequest::FBuilder.

Public Member Functions
COREUOBJECT_API	FBatchBuilder (int32 MaxCount)
COREUOBJECT_API bool	IsEmpty () const
COREUOBJECT_API FBatchBuilder &	Read (FBulkData &BulkData, EAsyncIOPriorityAndFlags Priority=DefaultPriority)
FBatchBuilder &	Read (const FBulkData &BulkData, uint64 Offset, uint64 Size, EAsyncIOPriorityAndFlags Priority, FIoBuffer &Dst)
FBatchBuilder &	Read (const FBulkData &BulkData, uint64 Offset, uint64 Size, EAsyncIOPriorityAndFlags Priority, FIoBuffer &Dst, FBulkDataBatchReadRequest &OutRequest)
COREUOBJECT_API void	Issue (FCompletionCallback &&Callback, FBulkDataBatchRequest &OutRequest)
COREUOBJECT_API void	Issue (FBulkDataBatchRequest &OutRequest)
COREUOBJECT_API void	Issue ()

Detailed Description

Issue one or more I/O request in a single batch.

Constructor & Destructor Documentation

FBatchBuilder()

FBulkDataBatchRequest::FBatchBuilder::FBatchBuilder

(

int32

MaxCount

)

Member Function Documentation

IsEmpty()

bool FBulkDataBatchRequest::FBatchBuilder::IsEmpty

(

)

const

Returns whether the batch is empty.

Issue() [1/3]

void FBulkDataBatchRequest::FBatchBuilder::Issue

(

)

Issue the batch.

Note

Assumes one or more handle(s) has been passed into any of the read operations.

Issue() [2/3]

void FBulkDataBatchRequest::FBatchBuilder::Issue

(

FBulkDataBatchRequest &

OutRequest

)

Issue the batch.

Parameters

OutRequest

A handle to the batch request.

Issue() [3/3]

void FBulkDataBatchRequest::FBatchBuilder::Issue	(	FCompletionCallback &&	Callback,
		FBulkDataBatchRequest &	OutRequest
	)

Issue the batch.

Parameters

Callback	Completion callback.
OutRequest	A handle to the batch request.

Read() [1/3]

FBatchBuilder & FBulkDataBatchRequest::FBatchBuilder::Read ( const FBulkData &  BulkData, uint64  Offset, uint64  Size, EAsyncIOPriorityAndFlags  Priority, FIoBuffer &  Dst  )

inline

Read the bulk data from the specified offset and size and copy the result into the destination buffer.

Parameters

BulkData	The bulk data instance.
Offset	Offset relative to the bulk data offset.
Size	Number of bytes to read. Use MAX_uint64 to read the entire bulk data.
Priority	The I/O priority.
Dst	An empty or preallocated I/O buffer.

Read() [2/3]

FBatchBuilder & FBulkDataBatchRequest::FBatchBuilder::Read ( const FBulkData &  BulkData, uint64  Offset, uint64  Size, EAsyncIOPriorityAndFlags  Priority, FIoBuffer &  Dst, FBulkDataBatchReadRequest &  OutRequest  )

inline

Read the bulk data from the specified offset and size and copy the result into the destination buffer.

Parameters

BulkData	The bulk data instance.
Offset	Offset relative to the bulk data.
Size	Number of bytes to read. Use MAX_uint64 to read the entire bulk data.
Priority	The I/O priority.
Dst	An empty or preallocated I/O buffer.
OutRequest	A handle to the read request.

Read() [3/3]

FBulkDataBatchRequest::FBatchBuilder & FBulkDataBatchRequest::FBatchBuilder::Read	(	FBulkData &	BulkData,
		EAsyncIOPriorityAndFlags	Priority = DefaultPriority
	)

Read the entire bulk data and copy the result to the specified instance.

---

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