UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FWindowsPlatformHttp Class Reference

#include <WindowsPlatformHttp.h>

+ Inheritance diagram for FWindowsPlatformHttp:

Static Public Member Functions

static HTTP_API void Init ()
 
static HTTP_API FHttpManagerCreatePlatformHttpManager ()
 
static HTTP_API void Shutdown ()
 
static HTTP_API IHttpRequestConstructRequest ()
 
static HTTP_API FString GetMimeType (const FString &FilePath)
 
static HTTP_API TOptional< FString > GetOperatingSystemProxyAddress ()
 
static HTTP_API bool IsOperatingSystemProxyInformationSupported ()
 
static HTTP_API bool VerifyPeerSslCertificate (bool verify)
 
- Static Public Member Functions inherited from FGenericPlatformHttp
static HTTP_API void Init ()
 
static FHttpManagerCreatePlatformHttpManager ()
 
static HTTP_API void Shutdown ()
 
static void ShutdownPlatformCustomSsl ()
 
static HTTP_API IHttpRequestConstructRequest ()
 
static HTTP_API FString UrlEncode (const FStringView UnencodedString)
 
static HTTP_API FString UrlDecode (const FStringView EncodedString)
 
static HTTP_API FString HtmlEncode (const FStringView UnencodedString)
 
static HTTP_API FString GetUrlDomainAndPort (const FStringView Url)
 
static HTTP_API FString GetUrlDomain (const FStringView Url)
 
static HTTP_API FString GetUrlBase (const FStringView Url)
 
static HTTP_API FString GetMimeType (const FString &FilePath)
 
static HTTP_API FString GetDefaultUserAgent ()
 
static HTTP_API FString EscapeUserAgentString (const FString &UnescapedString)
 
static HTTP_API void AddDefaultUserAgentProjectComment (const FString &Comment)
 
static HTTP_API void AddDefaultUserAgentPlatformComment (const FString &Comment)
 
static HTTP_API uint32 GetDefaultUserAgentVersion ()
 
static HTTP_API FDefaultUserAgentBuilder GetDefaultUserAgentBuilder ()
 
static HTTP_API TOptional< FString > GetOperatingSystemProxyAddress ()
 
static HTTP_API bool IsOperatingSystemProxyInformationSupported ()
 
static HTTP_API bool IsURLEncoded (const TArray< uint8 > &Payload)
 
static HTTP_API TOptional< FString > GetUrlParameter (const FStringView Url, const FStringView ParameterName)
 
static HTTP_API TOptional< uint16GetUrlPort (const FStringView Url)
 
static HTTP_API FString GetUrlPath (const FStringView Url, const bool bIncludeQueryString=false, const bool bIncludeFragment=false)
 
static HTTP_API TOptional< boolIsSecureProtocol (const FStringView Url)
 

Detailed Description

Platform specific HTTP implementations.

Member Function Documentation

◆ ConstructRequest()

IHttpRequest * FWindowsPlatformHttp::ConstructRequest ( )
static

Creates a new HTTP request instance for the current platform.

Returns
The request object.

◆ CreatePlatformHttpManager()

FHttpManager * FWindowsPlatformHttp::CreatePlatformHttpManager ( )
static

Creates a platform-specific HTTP manager.

Returns
nullptr if default implementation is to be used.

◆ GetMimeType()

FString FWindowsPlatformHttp::GetMimeType ( const FString &  FilePath)
static
Returns
the mime type for the file.

◆ GetOperatingSystemProxyAddress()

TOptional< FString > FWindowsPlatformHttp::GetOperatingSystemProxyAddress ( )
static

Get the proxy address specified by the operating system

Returns
optional FString: If unset: we are unable to get information from the operating system. If set: the proxy address set by the operating system (may be blank)

◆ Init()

void FWindowsPlatformHttp::Init ( )
static

Platform initialization step.

◆ IsOperatingSystemProxyInformationSupported()

bool FWindowsPlatformHttp::IsOperatingSystemProxyInformationSupported ( )
static

Check if getting proxy information from the current operating system is supported Useful for "Network Settings" type pages. GetProxyAddress may return an empty or populated string but that does not imply the operating system does or does not support proxies (or that it has been implemented here)

Returns
true if we are able to get proxy information from the current operating system, false if not

◆ Shutdown()

void FWindowsPlatformHttp::Shutdown ( )
static

Platform shutdown step.

◆ VerifyPeerSslCertificate()

bool FWindowsPlatformHttp::VerifyPeerSslCertificate ( bool  verify)
static

Verify Peer Ssl Certificate

Returns
optional bool: the previous value

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