1. Epic GamesDeveloper
  3. FHttpModule

FHttpModule

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

Unreal Engine C++ API Reference > Runtime > HTTP

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

Variables

  Type Name Description
Protected variable float HttpActivityTimeout Timeout in seconds to check there is any ongoing activity on the established connection
Protected variable float HttpConnectionTimeout Timeout in seconds to establish the connection
Protected variable float HttpTotalTimeout Timeout in seconds for the entire http request to complete. 0 is no timeout

Functions

  Type 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, ESPMode::ThreadSafe > 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 > &  
Public function Const const TMap< FString, FString > & Get the default headers that are appended to every request
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function FHttpManager & Only meant to be used by Http request/response implementations
Public function Const int32  
Public function Const const FString &  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const int32  
Public function Const const FString &  
Public function bool

HandleHTTPCommand ( const TCHAR* Cmd,
FOutputDevice& Ar
)

 Exec command handlers
Public function Const bool  
Public function Const bool  
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 the maximum size for the read buffer
Public function void

SetProxyAddress ( const FString& InProxyAddress
)

 Setter for the proxy address.
Public function Const bool Method to check dynamic proxy setting support.
Public function void

ToggleNullHttp ( bool bEnabled
)

 Toggle null http implementation
Public function void Update all config-based values

Overridden from FExec

  Type Name Description
Protected function Virtual bool

Exec_Runtime ( 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page