1. Epic GamesDeveloper
  3. FHttpManager

FHttpManager

Manages Http request that are currently being processed

API > API/Runtime > API/Runtime/HTTP

Inheritance Hierarchy

References

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

Syntax

class FHttpManager : public FTSTickerObjectBase

Remarks

Manages Http request that are currently being processed

Variables

  Type Name Description
Protected variable bool bFlushing This variable is set to true in Flush(EHttpFlushReason), and prevents new Http requests from being launched.
Protected variable bool bUseEventLoop  
Protected variable FCriticalSection CompletedRequestLock Used to lock access to get completed requests
Protected variable TFunction< FString()> CorrelationIdMethod This method will be called to generate a CorrelationId on all requests being sent if one is not already set
Protected variable TMap< EHttpFlushReason, FHttpFlushTimeLimit > FlushTimeLimitsMap  
Protected variable FTSTicker GameThreadTicker Ticker to run game thread tasks
Protected variable FCriticalSection GameThreadTickerLock  
Protected variable FHttpStats HttpStats  
Protected variable FHttpStatsHistory HttpStatsHistory  
Protected variable FHttpManagerRequestAddedDelegate RequestAddedDelegate Delegate that will get called once request added
Protected variable FHttpManagerRequestCompletedDelegate RequestCompletedDelegate Delegate that will get called when a request completes
Protected variable FCriticalSection RequestLock Used to lock access to add/remove/find requests
Protected variable TArray< FHttpRequestRef > Requests List of Http requests that are actively being processed
Protected variable FHttpThreadBase * Thread  
Protected variable TArray< FString > UrlPatternsToLogResponse  
Protected variable FCriticalSection UrlPatternsToLogResponseCriticalSection  
Protected variable TMap< FString, int32 > UrlPatternsToMockFailure  
Protected variable FCriticalSection UrlPatternsToMockFailureCriticalSection  
Protected variable UE::Core::FURLRequestFilter URLRequestFilter Url request filter, if specified in the config, it will launch http request only when the url is in the allowlist

Constructors

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Public function void

AddGameThreadTask ( TFunction< void()>&& Task,
float Delay
)

 Add task to be ran on the game thread next tick
Public function TSharedPtr< IHttpTaskTimerHandle >

AddHttpThreadTask ( TFunction< void()>&& Task,
float InDelay
)

 Add task to be ran on the http thread
Public function void

AddRequest ( const FHttpRequestRef& Request
)

 Adds an Http request instance to the manager for tracking/ticking Manager should always have a list of requests currently being processed
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS void Add a http request to be executed on the http thread
Protected function void Broadcast that a non-threaded HTTP request is complete.
Public function void Mark a threaded http request as cancelled to be removed from the http thread
Public function Const FString Create a new correlation id for a request
Protected function Virtual FHttpThreadBase * Create HTTP thread object
Public function Const void List all of the Http requests currently being processed
Public function void

Flush ( EHttpFlushReason FlushReason
)

 Block until all pending requests are finished processing
Public function Virtual void

FlushTick ( float DeltaSeconds
)

 Tick called during Flush
Public function Static TFunction< FString()> Get the default method for creating new correlation ids for a request
Public function Const FHttpStats  
Protected function TOptional< int32 >  
Protected function FHttpThreadBase * Access http thread of http manager for internal usage
Protected function Const bool  
Public function void Initialize
Public function Const bool

IsDomainAllowed ( const FString& Url
)

 Determine if the domain is allowed to be accessed
Public function Const bool

IsValidRequest ( const IHttpRequest* RequestPtr
)

 Find an Http request in the lists of current valid requests
Public function Virtual void Inform that HTTP Manager that we have completed a fork().
Public function Virtual void Inform that HTTP Manager that we are about to fork().
Public function Virtual void Inform the HTTP Manager that we finished ticking right after forking.
Protected function void

RecordMaxTimeToWaitInQueue ( float Duration
)

 Record the time to wait in queue, to have a general idea how long the client usually wait before actually starting, to adjust the requests
Protected function void

RecordPlatformStats ( const FHttpStatsPlatform& PlatformStats
)

 Record platform specific stats
Protected function void

RecordStatRequestsInFlight ( uint32 RequestsInFlight
)

 Record the requests waiting in flight, to have an idea if there are too many concurrent requests
Protected function void

RecordStatRequestsInQueue ( uint32 RequestsInQueue
)

 Record the requests waiting in queue, to have an idea if there are too many requests or if request number limit is too small
Protected function void

RecordStatTimeToConnect ( float Duration
)

 Record the time to connect, to have a general idea how long the client usually take to connect for success requests, to adjust the connection timeout
Protected function void  
Public function void

RemoveHttpThreadTask ( TSharedPtr< IHttpTaskTimerHandle > HttpTaskTimerHandle
)

 Remove the task from the http thread before it's triggered
Public function void

RemoveRequest ( const FHttpRequestRef& Request
)

 Removes an Http request instance from the manager Presumably it is done being processed
Public function void

SetCorrelationIdMethod ( TFunction< FString()> InCorrelationIdMethod
)

 Set the method used to set a Correlation id on each request, if one is not already specified.
Public function void Set a delegate to be triggered when an http request added to http manager.
Public function void Set a delegate to be triggered when an http request completed.
Public function void

SetURLRequestFilter ( const UE::Core::FURLRequestFilter& InURLRequestFilter
)

 Set url request filter through code, instead of setting it through config.
Protected function bool  
Public function void Shutdown logic should be called before quiting
Public function Virtual Const bool Method to check dynamic proxy setting support.
Public function Virtual void Update configuration. Called when config has been updated and we need to apply any changes.
Protected function void  
Protected function void  

Overridden from FTSTickerObjectBase

  Type Name Description
Public function Virtual bool

Tick ( float DeltaSeconds
)

 FTSTicker callback

Classes

  Type Name Description
Protected struct FHttpFlushTimeLimit    
Protected struct FHttpStatsHistory    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page