UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::IHttpIoDispatcher Class Referenceabstract

#include <HttpIoDispatcher.h>

+ Inheritance diagram for UE::IHttpIoDispatcher:

Public Types

using FHostGroupRegistered = FHttpIoDispatcher::FHostGroupRegistered
 

Public Member Functions

virtual ~IHttpIoDispatcher ()=default
 
virtual void Shutdown ()=0
 
virtual FIoStatus RegisterHostGroup (const FName &HostGroup, TConstArrayView< FAnsiString > HostNames, FAnsiStringView TestUrl)=0
 
virtual bool IsHostGroupRegistered (const FName &HostGroup)=0
 
virtual bool IsHostGroupOk (const FName &HostGroup)=0
 
virtual FHostGroupRegisteredOnHostGroupRegistered ()=0
 
virtual FIoHttpRequestHandle CreateRequest (FIoHttpRequestHandle &First, FIoHttpRequestHandle &Last, const FName &HostGroup, const FIoRelativeUrl &RelativeUrl, const FIoHttpOptions &Options, FIoHttpHeaders &&Headers, FIoHttpRequestCompleted &&OnCompleted, const FIoHash *ChunkHash=nullptr)=0
 
virtual void IssueRequest (FIoHttpRequestHandle RequestHandle)=0
 
virtual void CancelRequest (FIoHttpRequestHandle Handle)=0
 
virtual void UpdateRequestPriority (FIoHttpRequestHandle Handle, int32 NewPriority)=0
 
virtual EIoErrorCode GetRequestStatus (FIoHttpRequestHandle Handle)=0
 
virtual void ReleaseRequest (FIoHttpRequestHandle Handle)=0
 
virtual FIoStatus CacheResponse (const FIoHttpResponse &Response)=0
 
virtual FIoStatus EvictFromCache (const FIoHttpResponse &Response)=0
 

Detailed Description

HTTP I/O dispatcher interface.

Member Typedef Documentation

◆ FHostGroupRegistered

using UE::IHttpIoDispatcher::FHostGroupRegistered = FHttpIoDispatcher::FHostGroupRegistered

Constructor & Destructor Documentation

◆ ~IHttpIoDispatcher()

virtual UE::IHttpIoDispatcher::~IHttpIoDispatcher ( )
virtualdefault

Member Function Documentation

◆ CacheResponse()

virtual FIoStatus UE::IHttpIoDispatcher::CacheResponse ( const FIoHttpResponse Response)
pure virtual

◆ CancelRequest()

virtual void UE::IHttpIoDispatcher::CancelRequest ( FIoHttpRequestHandle  Handle)
pure virtual

◆ CreateRequest()

virtual FIoHttpRequestHandle UE::IHttpIoDispatcher::CreateRequest ( FIoHttpRequestHandle First,
FIoHttpRequestHandle Last,
const FName HostGroup,
const FIoRelativeUrl RelativeUrl,
const FIoHttpOptions Options,
FIoHttpHeaders &&  Headers,
FIoHttpRequestCompleted &&  OnCompleted,
const FIoHash ChunkHash = nullptr 
)
pure virtual

◆ EvictFromCache()

virtual FIoStatus UE::IHttpIoDispatcher::EvictFromCache ( const FIoHttpResponse Response)
pure virtual

◆ GetRequestStatus()

virtual EIoErrorCode UE::IHttpIoDispatcher::GetRequestStatus ( FIoHttpRequestHandle  Handle)
pure virtual

◆ IsHostGroupOk()

virtual bool UE::IHttpIoDispatcher::IsHostGroupOk ( const FName HostGroup)
pure virtual

◆ IsHostGroupRegistered()

virtual bool UE::IHttpIoDispatcher::IsHostGroupRegistered ( const FName HostGroup)
pure virtual

◆ IssueRequest()

virtual void UE::IHttpIoDispatcher::IssueRequest ( FIoHttpRequestHandle  RequestHandle)
pure virtual

◆ OnHostGroupRegistered()

virtual FHostGroupRegistered & UE::IHttpIoDispatcher::OnHostGroupRegistered ( )
pure virtual

◆ RegisterHostGroup()

virtual FIoStatus UE::IHttpIoDispatcher::RegisterHostGroup ( const FName HostGroup,
TConstArrayView< FAnsiString HostNames,
FAnsiStringView  TestUrl 
)
pure virtual

◆ ReleaseRequest()

virtual void UE::IHttpIoDispatcher::ReleaseRequest ( FIoHttpRequestHandle  Handle)
pure virtual

◆ Shutdown()

virtual void UE::IHttpIoDispatcher::Shutdown ( )
pure virtual

◆ UpdateRequestPriority()

virtual void UE::IHttpIoDispatcher::UpdateRequestPriority ( FIoHttpRequestHandle  Handle,
int32  NewPriority 
)
pure virtual

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