IHttpRequest.h File Reference

#include "CoreMinimal.h"
#include "Interfaces/IHttpBase.h"

Go to the source code of this file.

Classes
class	IHttpRequest

Namespaces
namespace	HttpRequestOptions

Typedefs
typedef TSharedPtr< IHttpRequest, ESPMode::ThreadSafe >	FHttpRequestPtr
typedef TSharedPtr< IHttpResponse, ESPMode::ThreadSafe >	FHttpResponsePtr
typedef TSharedRef< IHttpRequest, ESPMode::ThreadSafe >	FHttpRequestRef
typedef TSharedRef< IHttpResponse, ESPMode::ThreadSafe >	FHttpResponseRef
using	FHttpRequestCompleteDelegate = TTSDelegate< void(FHttpRequestPtr, FHttpResponsePtr, bool)>
using	FHttpRequestStatusCodeReceivedDelegate = TTSDelegate< void(FHttpRequestPtr, int32)>
using	FHttpRequestHeaderReceivedDelegate = TTSDelegate< void(FHttpRequestPtr, const FString &, const FString &)>
using	FHttpRequestProgressDelegate = TTSDelegate< void(FHttpRequestPtr, int32, int32)>
using	FHttpRequestProgressDelegate64 = TTSDelegate< void(FHttpRequestPtr, uint64, uint64)>
using	FHttpRequestWillRetryDelegate = TTSDelegate< void(FHttpRequestPtr, FHttpResponsePtr, float)>
using	FHttpRequestStreamDelegate = TTSDelegate< bool(void *, int64)>
using	FHttpRequestStreamDelegateV2 = TTSDelegate< void(void *, int64 &)>

Enumerations
enum class	EHttpRequestDelegateThreadPolicy : uint8 { CompleteOnGameThread = 0 , CompleteOnHttpThread }
enum class	EHttpRequestPriority : uint8 {   Lowest = 0 , Low , Normal , High ,   Highest }
enum class	EHttpRequestMode : uint8 { ThreadedRequest , ImmediateRequest }

Functions
HTTP_API const TCHAR *	LexToString (EHttpRequestMode Mode)

Typedef Documentation

FHttpRequestCompleteDelegate

using FHttpRequestCompleteDelegate = TTSDelegate<void(FHttpRequestPtr , FHttpResponsePtr , bool )>

Delegate called when an Http request completes

Parameters

Request	original Http request that started things
Response	response received from the server if a successful connection was established. Note that even if response is not null, it doesn't mean the request was processed successfully. Use Response->GetStatus(), Response->GetFailureReason() and Response->GetResponseCode() to decide how to handle it
bProcessedSuccessfully	this flag indicates whether or not the request was able to be processed successfully. It could be connect error, timeout error or platform http error. Note that when this flag is true doesn't mean the http request get 2xx success status code, it just means this request got response from http server and completed the processing

FHttpRequestHeaderReceivedDelegate

using FHttpRequestHeaderReceivedDelegate = TTSDelegate<void(FHttpRequestPtr , const FString& , const FString& )>

Delegate called when an Http request receives a header

Parameters

Request	original Http request that started things
HeaderName	the name of the header
NewHeaderValue	the value of the header

FHttpRequestProgressDelegate

using FHttpRequestProgressDelegate = TTSDelegate<void(FHttpRequestPtr , int32 , int32 )>

Delegate called per tick to update an Http request upload or download size progress

Parameters

Request	original Http request that started things
BytesSent	the number of bytes sent / uploaded in the request so far.
BytesReceived	the number of bytes received / downloaded in the response so far.

FHttpRequestProgressDelegate64

using FHttpRequestProgressDelegate64 = TTSDelegate<void(FHttpRequestPtr , uint64 , uint64 )>

Delegate called per tick to update an Http request upload or download size progress

Parameters

Request	original Http request that started things
BytesSent	the number of bytes sent / uploaded in the request so far.
BytesReceived	the number of bytes received / downloaded in the response so far.

FHttpRequestPtr

typedef TSharedPtr<IHttpRequest, ESPMode::ThreadSafe> FHttpRequestPtr

FHttpRequestRef

typedef TSharedRef<IHttpRequest, ESPMode::ThreadSafe> FHttpRequestRef

FHttpRequestStatusCodeReceivedDelegate

using FHttpRequestStatusCodeReceivedDelegate = TTSDelegate<void(FHttpRequestPtr , int32 )>

Delegate called when an Http request receives status code

Parameters

Request	original Http request that started things
status	code

FHttpRequestStreamDelegate

using FHttpRequestStreamDelegate = TTSDelegate<bool(void*, int64)>

Delegate called when an Http request will send/recv data through stream

Parameters

Ptr	- The buffer ptr to read/write
Length	- The length of buffer to read/write

Returns

true if succeed, false if failed to read/write data

FHttpRequestStreamDelegateV2

using FHttpRequestStreamDelegateV2 = TTSDelegate<void(void*, int64&)>

Delegate called when an Http request will send/recv data through stream

Parameters

Ptr	- The buffer ptr to read/write
InOutLength	- The int64 reference length of buffer to read/write, if there is any error when serialize set it to 0

FHttpRequestWillRetryDelegate

using FHttpRequestWillRetryDelegate = TTSDelegate<void(FHttpRequestPtr , FHttpResponsePtr , float )>

Delegate called when an Http request will be retried in the future

Parameters

Request	- original Http request that started things
Response	- response received from the server if a successful connection was established
SecondsToRetry	- seconds in the future when the response will be retried

FHttpResponsePtr

typedef TSharedPtr<IHttpResponse, ESPMode::ThreadSafe> FHttpResponsePtr

FHttpResponseRef

typedef TSharedRef<IHttpResponse, ESPMode::ThreadSafe> FHttpResponseRef

Enumeration Type Documentation

EHttpRequestDelegateThreadPolicy

enum class EHttpRequestDelegateThreadPolicy : uint8

strong

Enumerates thread policy about which thread to complete the http request

Enumerator
CompleteOnGameThread
CompleteOnHttpThread

EHttpRequestMode

enum class EHttpRequestMode : uint8

strong

Mode that can be specified through IHttpRequest::SetOption(HttpRequestOptions::RequestMode, LexToString(EHttpRequestMode::Value));

Enumerator
ThreadedRequest	The request will be enqueued to the http manager thread system
ImmediateRequest	The request will be immediately sent when the platform supports it

EHttpRequestPriority

enum class EHttpRequestPriority : uint8

strong

Enumerates priority to decide how the request will be queued when max concurrent limit reached The priority will be compared through value, so it's important to keep the order from low to high

Enumerator
Lowest
Low
Normal
High
Highest

Function Documentation

LexToString()

HTTP_API const TCHAR * LexToString

(

EHttpRequestMode

Mode

)