#include <OnDemandHttpThread.h>

Inheritance diagram for UE::IoStore::FOnDemandHttpThread:

Public Types
using	FCompletionCallback = TUniqueFunction< void(uint32, FStringView, FIoBuffer &&)>

using	FRequestHandle = void *

Public Member Functions
	DECLARE_TS_MULTICAST_DELEGATE (FOnTickIdle)

	FOnDemandHttpThread ()

virtual	~FOnDemandHttpThread ()

FRequestHandle	IssueRequest (const FOnDemandChunkInfo &ChunkInfo, const FIoOffsetAndLength &ReadRange, int32 Priority, FCompletionCallback &&CompletionCallback, EHttpRequestType Type)

FRequestHandle	IssueRequest (FOnDemandChunkInfo &&ChunkInfo, const FIoOffsetAndLength &ReadRange, int32 Priority, FCompletionCallback &&CompletionCallback, EHttpRequestType Type)

void	ReprioritizeRequest (FRequestHandle Request, int32 NewPriority)

void	CancelRequest (FRequestHandle Request)

FOnTickIdle &	OnTickIdle ()

virtual class FSingleThreadRunnable *	GetSingleThreadInterface () override

Public Member Functions inherited from FRunnable
virtual	~FRunnable ()

Public Member Functions inherited from FSingleThreadRunnable
virtual	~FSingleThreadRunnable ()

Static Public Member Functions
static FOnDemandHttpThread &	Get ()

Member Typedef Documentation

◆ FCompletionCallback

using UE::IoStore::FOnDemandHttpThread::FCompletionCallback = TUniqueFunction<void(uint32 , FStringView, FIoBuffer&& )>

◆ FRequestHandle

using UE::IoStore::FOnDemandHttpThread::FRequestHandle = void*

Constructor & Destructor Documentation

◆ FOnDemandHttpThread()

UE::IoStore::FOnDemandHttpThread::FOnDemandHttpThread ( )

◆ ~FOnDemandHttpThread()

UE::IoStore::FOnDemandHttpThread::~FOnDemandHttpThread ( )

virtual

Member Function Documentation

◆ CancelRequest()

void UE::IoStore::FOnDemandHttpThread::CancelRequest ( FRequestHandle Request )

◆ DECLARE_TS_MULTICAST_DELEGATE()

UE::IoStore::FOnDemandHttpThread::DECLARE_TS_MULTICAST_DELEGATE ( FOnTickIdle )

◆ Get()

static FOnDemandHttpThread & UE::IoStore::FOnDemandHttpThread::Get ( )

static

◆ GetSingleThreadInterface()

virtual class FSingleThreadRunnable * UE::IoStore::FOnDemandHttpThread::GetSingleThreadInterface ( )

inlineoverridevirtual

Gets single thread interface pointer used for ticking this runnable when multi-threading is disabled. If the interface is not implemented, this runnable will not be ticked when FPlatformProcess::SupportsMultithreading() is false.

Returns: Pointer to the single thread interface or nullptr if not implemented.

Reimplemented from FRunnable.

◆ IssueRequest() [1/2]

FOnDemandHttpThread::FRequestHandle UE::IoStore::FOnDemandHttpThread::IssueRequest	(	const FOnDemandChunkInfo &	ChunkInfo,
		const FIoOffsetAndLength &	ReadRange,
		int32	Priority,
		FCompletionCallback &&	CompletionCallback,
		EHttpRequestType	Type
	)

Issue a http request to read from a chunk.

Parameters

ChunkInfo	Info about the chunk to be read
ReadRange	The range from within the chunk to read. A default FIoOffsetAndLength will read the entire chunk.
Priority	The priority of the request. Currently maps to EIoDispatcherPriority but may be expanded on in the future. @CompletionCallback A callback that will be invoked when the http request has completed. This will be invoked on the thread that the http requests are being processed on and will block new requests being queued so care should be taken to do as little work in the callback as possible.

Returns: A handle representing the request which can be used to modify it while the request is still in flight. The handle will no longer be valid after the CompletionCallback has been invoked.

◆ IssueRequest() [2/2]

FOnDemandHttpThread::FRequestHandle UE::IoStore::FOnDemandHttpThread::IssueRequest	(	FOnDemandChunkInfo &&	ChunkInfo,
		const FIoOffsetAndLength &	ReadRange,
		int32	Priority,
		FCompletionCallback &&	CompletionCallback,
		EHttpRequestType	Type
	)

Issue a http request to read from a chunk.

Parameters

ChunkInfo	Info about the chunk to be read
ReadRange	The range from within the chunk to read. A default FIoOffsetAndLength will read the entire chunk.
Priority	The priority of the request. Currently maps to EIoDispatcherPriority but may be expanded on in the future. @CompletionCallback A callback that will be invoked when the http request has completed. This will be invoked on the thread that the http requests are being processed on and will block new requests being queued so care should be taken to do as little work in the callback as possible.

Returns: A handle representing the request which can be used to modify it while the request is still in flight. The handle will no longer be valid after the CompletionCallback has been invoked.

◆ OnTickIdle()

FOnTickIdle & UE::IoStore::FOnDemandHttpThread::OnTickIdle ( )

inline

◆ ReprioritizeRequest()

void UE::IoStore::FOnDemandHttpThread::ReprioritizeRequest	(	FRequestHandle	Request,
		int32	NewPriority
	)

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

Engine/Source/Runtime/Experimental/IoStore/OnDemand/Private/OnDemandHttpThread.h
Engine/Source/Runtime/Experimental/IoStore/OnDemand/Private/OnDemandHttpThread.cpp

Public Types

Public Member Functions

Static Public Member Functions