1. Epic GamesDeveloper
  3. FHttpRequestCommon

FHttpRequestCommon

Contains implementation of some common functions that don't vary between implementations of different platforms

API > API/Runtime > API/Runtime/HTTP > API/Runtime/HTTP/GenericPlatform

Inheritance Hierarchy

References

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

Syntax

class FHttpRequestCommon : public FHttpRequestImpl

Remarks

Contains implementation of some common functions that don't vary between implementations of different platforms

Variables

  Type Name Description
Protected variable double ActivityTimeoutAt Record when this request will activity timeout
Protected variable TSharedPtr< IHttpTaskTimerHandle > ActivityTimeoutHttpTaskTimerHandle Holder the timer handle, if the request get destroyed before triggering the timeout, use this to remove the timer
Protected variable TOptional< float > ActivityTimeoutSecs Timeout in seconds for the HTTP request activity timeout
Protected variable std::atomic< bool > bActivityTimedOut Indicate the request is activity timed out, it should quit and fail with EHttpFailureReason::ConnectionError
Protected variable std::atomic< bool > bCanceled Indicate the request is cancelled, it should quit and fail with EHttpFailureReason::Cancelled
Protected variable std::atomic< bool > bInitializedWithValidStream Flag to indicate the request was initialized with stream.
Protected variable std::atomic< bool > bTimedOut Indicate the request is timed out, it should quit and fail with EHttpFailureReason::TimedOut
Protected variable bool bUsePlatformActivityTimeout TODO: Move this feature into CurlHttp
Protected variable EHttpRequestStatus::Type CompletionStatus Current status of request being processed
Protected variable double ConnectTime Record how long it take to connect to the endpoint
Protected variable EHttpRequestDelegateThreadPolicy DelegateThreadPolicy Thread policy about which thread to complete this request
Protected variable FString EffectiveURL Cache the effective URL. When redirected, it will be different with original URL
Protected variable EHttpFailureReason FailureReason Reason of failure of the HTTP request
Protected variable FCriticalSection HttpTaskTimerHandleCriticalSection Critical section for accessing HttpTaskTimerHandle
Protected variable TUniquePtr< FRequestPayload > RequestPayload Payload to use with the request. Typically for POST, PUT, or PATCH
Protected variable double RequestStartTimeAbsoluteSeconds Record when this request started
Protected variable TSharedPtr< FArchive > ResponseBodyReceiveStream The stream to receive response body
Protected variable FCriticalSection ResponseBodyReceiveStreamCriticalSection Critical section for accessing ResponseBodyReceiveStream
Protected variable TSharedPtr< FHttpResponseCommon > ResponseCommon The response object which we will use to pair with this request
Protected variable double StartProcessTime Record when the request start to process
Protected variable TOptional< float > TimeoutSecs Timeout in seconds for the entire HTTP request to complete
Protected variable TSharedPtr< IHttpTaskTimerHandle > TotalTimeoutHttpTaskTimerHandle Holder the timer handle, if the request get destroyed before triggering the timeout, use this to remove the timer

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void  
Protected function void  
Protected function Virtual void  
Protected function void  
Public function void Can be called on game thread or http thread depend on the delegate thread policy.
Protected function void Finish the request when it's not in http manager
Protected function Const float  
Public function Const float  
Protected function void  
Protected function void  
Protected function void  
Protected function bool  
Protected function bool

PassReceivedDataToStream ( void* Ptr,
int64 Length
)

  
Protected function void  
Protected function Const bool  
Protected function bool Check if this request is valid or allowed, before actually process the request
Protected function void  
Protected function bool  
Protected function void

SetEffectiveURL ( const FString& InEffectiveURL
)

  
Protected function void

SetFailureReason ( EHttpFailureReason InFailureReason
)

  
Protected function void

SetStatus ( EHttpRequestStatus::Type InCompletionStatus
)

  
Protected function bool  
Protected function void  
Protected function void

StartActivityTimeoutTimerBy ( double DelayToTrigger
)

  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  

Overridden from FHttpRequestImpl

  Type Name Description
Public function Virtual void Clear callbacks before http module get deleted

Overridden from IHttpRequest

  Type Name Description
Public function Virtual void Called to cancel a request that is still being processed
Public function Virtual void Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used.
Public function Virtual Const EHttpRequestDelegateThreadPolicy Get thread policy about which thread to complete this request
Public function Virtual Const const FHttpResponsePtr Get the associated Response
Public function Virtual Const TOptional< float > Gets the optional timeout in seconds for this entire HTTP request to complete.
Public function Virtual void Blocking call to wait the request until it's completed
Public function Virtual void

SetActivityTimeout ( float InTimeoutSecs
)

 Sets an optional activity timeout in seconds for this HTTP request.
Public function Virtual void Set thread policy about which thread to trigger the delegates, set by FHttpManager::SetRequestCompletedDelegate, IHttpRequest::OnStatusCodeReceived, IHttpRequest::OnHeaderReceived, IHttpRequest::OnRequestProgress64 and IHttpRequest::OnProcessRequestComplete.
Public function Virtual bool Sets the stream to receive the response body.
Public function Virtual void

SetTimeout ( float InTimeoutSecs
)

 Sets an optional timeout in seconds for this entire HTTP request to complete.

Overridden from IHttpBase

  Type Name Description
Public function Virtual Const const FString & Get the effective URL in case of redirected. If not redirected, it's the same as GetURL
Public function Virtual Const EHttpFailureReason Get the reason of th failure if GetStatus returns Failed
Public function Virtual Const EHttpRequestStatus::Type IHttpRequest.
Public function Virtual Const FString

GetURLParameter ( const FString& ParameterName
)

 IHttpBase.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page