Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > HTTP > FHttpModule

Light Theme

Dark Theme

FHttpModule

Module for Http request implementations Use FHttpFactory to create a new Http request

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

FSelfRegisteringExec

FHttpModule

References

Module	HTTP
Header	/Engine/Source/Runtime/Online/HTTP/Public/HttpModule.h
Include	#include "HttpModule.h"

Syntax

class FHttpModule :
public IModuleInterface,
public FSelfRegisteringExec

Remarks

Module for Http request implementations Use FHttpFactory to create a new Http request

Functions

	Name	Description
void	AddDefaultHeader ( const FString& HeaderName, const FString& HeaderValue )	Add a default header to be appended to future requests If a request already specifies this header, then the defaulted version will not be used
TSharedRef< ...	CreateRequest()	Instantiates a new Http request for the current platform
FHttpModule ...	Get()	Singleton-like access to this module's interface.
const TArray...	GetAllowedDomains()
const TMap< ...	GetDefaultHeaders()	Get the default headers that are appended to every request
float	GetHttpConnectionTimeout()
float	GetHttpDelayTime()
FHttpManager...	GetHttpManager()	Only meant to be used by Http request/response implementations
int32	GetHttpMaxConnectionsPerServer()
float	GetHttpReceiveTimeout()
float	GetHttpSendTimeout()
float	GetHttpThreadActiveFrameTimeInSeconds()
float	GetHttpThreadActiveMinimumSleepTimeInSeconds()
float	GetHttpThreadIdleFrameTimeInSeconds()
float	GetHttpThreadIdleMinimumSleepTimeInSeconds()
float	GetHttpTimeout()
int32	GetMaxReadBufferSize()
const FStrin...	GetProxyAddress()
bool	HandleHTTPCommand ( const TCHAR* Cmd, FOutputDevice& Ar )	Exec command handlers
bool	IsHttpEnabled()
bool	IsNullHttpEnabled()
void	SetHttpDelayTime ( float InHttpDelayTime )	Set the min delay time for each http request
void	SetHttpThreadActiveFrameTimeInSeconds ( float InHttpThreadActiveFrameTimeIn... )	Set the target tick rate of an active http thread
void	SetHttpThreadActiveMinimumSleepTimeInSeconds ( float InHttpThreadActiveMinimumSlee... )	Set the minimum sleep time of an active http thread
void	SetHttpThreadIdleFrameTimeInSeconds ( float InHttpThreadIdleFrameTimeInSe... )	Set the target tick rate of an idle http thread
void	SetHttpThreadIdleMinimumSleepTimeInSeconds ( float InHttpThreadIdleMinimumSleepT... )	Set the minimum sleep time when idle, waiting for requests
void	SetHttpTimeout ( float TimeOutInSec )	Sets timeout in seconds for the entire http request to complete
void	SetMaxReadBufferSize ( int32 SizeInBytes )	Sets timeout in seconds for the entire http request to complete
void	SetProxyAddress ( const FString& InProxyAddress )	Setter for the proxy address.
bool	SupportsDynamicProxy()	Method to check dynamic proxy setting support.
void	ToggleNullHttp ( bool bEnabled )	Toggle null http implementation
void	UpdateConfigs()	Update all config-based values

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Handle exec commands starting with "HTTP"

Constants

Name	Description
Singleton	Singleton for the module while loaded and available

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss