FHttpModule

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

Windows
MacOS
Linux

Inheritance Hierarchy

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

Public function

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

Public function Virtual

TSharedRef< IHttpRequest >

 

CreateRequest()

Instantiates a new Http request for the current platform

Public function Static

FHttpModule &

 

Get()

Singleton-like access to this module's interface.

Public function Const

const TArray< FString > &

 

GetAllowedDomains()

Public function Const

const TMap< FString, FString > &

 

GetDefaultHeaders()

Get the default headers that are appended to every request

Public function Const

float

 

GetHttpConnectionTimeout()

Public function Const

float

 

GetHttpDelayTime()

Public function

FHttpManager &

 

GetHttpManager()

Only meant to be used by Http request/response implementations

Public function Const

int32

 

GetHttpMaxConnectionsPerServer()

Public function Const

float

 

GetHttpReceiveTimeout()

Public function Const

float

 

GetHttpSendTimeout()

Public function Const

float

 

GetHttpThreadActiveFrameTimeInSeconds()

Public function Const

float

 

GetHttpThreadActiveMinimumSleepTimeInSeconds()

Public function Const

float

 

GetHttpThreadIdleFrameTimeInSeconds()

Public function Const

float

 

GetHttpThreadIdleMinimumSleepTimeInSeconds()

Public function Const

float

 

GetHttpTimeout()

Public function Const

int32

 

GetMaxReadBufferSize()

Public function Const

const FString &

 

GetProxyAddress()

Public function

bool

 

HandleHTTPCommand

(
    const TCHAR* Cmd,
    FOutputDevice& Ar
)

Exec command handlers

Public function Const

bool

 

IsHttpEnabled()

Public function Const

bool

 

IsNullHttpEnabled()

Public function

void

 

SetHttpDelayTime

(
    float InHttpDelayTime
)

Set the min delay time for each http request

Public function

void

 

SetHttpThreadActiveFrameTimeInSeconds

(
    float InHttpThreadActiveFrameTimeInSeconds
)

Set the target tick rate of an active http thread

Public function

void

 

SetHttpThreadActiveMinimumSleepTimeInSeconds

(
    float InHttpThreadActiveMinimumSleepTimeInSeconds
)

Set the minimum sleep time of an active http thread

Public function

void

 

SetHttpThreadIdleFrameTimeInSeconds

(
    float InHttpThreadIdleFrameTimeInSeconds
)

Set the target tick rate of an idle http thread

Public function

void

 

SetHttpThreadIdleMinimumSleepTimeInSeconds

(
    float InHttpThreadIdleMinimumSleepTimeInSeconds
)

Set the minimum sleep time when idle, waiting for requests

Public function

void

 

SetHttpTimeout

(
    float TimeOutInSec
)

Sets timeout in seconds for the entire http request to complete

Public function

void

 

SetMaxReadBufferSize

(
    int32 SizeInBytes
)

Sets timeout in seconds for the entire http request to complete

Public function

void

 

SetProxyAddress

(
    const FString& InProxyAddress
)

Setter for the proxy address.

Public function Const

bool

 

SupportsDynamicProxy()

Method to check dynamic proxy setting support.

Public function

void

 

ToggleNullHttp

(
    bool bEnabled
)

Toggle null http implementation

Public function

void

 

UpdateConfigs()

Update all config-based values

Overridden from FExec

Name Description

Public function Virtual

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback