IBackgroundHttpRequest.h File Reference

#include "CoreMinimal.h"
#include "BackgroundHttpNotificationObject.h"
#include "Interfaces/IHttpResponse.h"
#include "BackgroundHttpMetrics.h"

Go to the source code of this file.

Classes
class	IBackgroundHttpRequest

Typedefs
typedef TSharedPtr< class IBackgroundHttpRequest, ESPMode::ThreadSafe >	FBackgroundHttpRequestPtr
typedef TSharedPtr< class IBackgroundHttpResponse, ESPMode::ThreadSafe >	FBackgroundHttpResponsePtr
typedef TSharedPtr< class IBackgroundHttpManager, ESPMode::ThreadSafe >	FBackgroundHttpManagerPtr

Enumerations
enum class	EBackgroundHTTPPriority : uint8 { High , Normal , Low , Num }

Functions
	DECLARE_DELEGATE_TwoParams (FBackgroundHttpRequestCompleteDelegate, FBackgroundHttpRequestPtr, bool)
	DECLARE_DELEGATE_ThreeParams (FBackgroundHttpProgressUpdateDelegate, FBackgroundHttpRequestPtr, int32, int32)
	DECLARE_DELEGATE_ThreeParams (FBackgroundHttpRequestMetricsDelegate, FBackgroundHttpRequestPtr, int32, float)
	DECLARE_DELEGATE_TwoParams (FBackgroundHttpRequestMetricsExtendedDelegate, FBackgroundHttpRequestPtr, FBackgroundHttpRequestMetricsExtended)
const TCHAR *	LexToString (EBackgroundHTTPPriority InType)
bool	LexTryParseString (EBackgroundHTTPPriority &OutMode, const TCHAR *InBuffer)

Typedef Documentation

FBackgroundHttpManagerPtr

typedef TSharedPtr<class IBackgroundHttpManager, ESPMode::ThreadSafe> FBackgroundHttpManagerPtr

FBackgroundHttpRequestPtr

typedef TSharedPtr<class IBackgroundHttpRequest, ESPMode::ThreadSafe> FBackgroundHttpRequestPtr

FBackgroundHttpResponsePtr

typedef TSharedPtr<class IBackgroundHttpResponse, ESPMode::ThreadSafe> FBackgroundHttpResponsePtr

Enumeration Type Documentation

EBackgroundHTTPPriority

enum class EBackgroundHTTPPriority : uint8

strong

Enum used to describe download priority. Higher priorities will be downloaded first. Note: Should always be kept in High -> Low priority order if adding more Priorities!

Enumerator
High
Normal
Low
Num

Function Documentation

DECLARE_DELEGATE_ThreeParams() [1/2]

DECLARE_DELEGATE_ThreeParams	(	FBackgroundHttpProgressUpdateDelegate	,
		FBackgroundHttpRequestPtr	,
		int32	,
		int32
	)

Delegate Called when a Background Http request updates its progress

Parameters

Request	Background Http Request that is updating its progress
TotalBytesWritten	Amount of data we have written so far. Total Figure.
BytesWrittenSinceLastUpdate	Amount of data we have written since our last call to this delegate.

DECLARE_DELEGATE_ThreeParams() [2/2]

DECLARE_DELEGATE_ThreeParams	(	FBackgroundHttpRequestMetricsDelegate	,
		FBackgroundHttpRequestPtr	,
		int32	,
		float
	)

Delegate called when a Background Http request metrics are ready

Parameters

Request	Background Http Request for which the metrics were calculated
TotalBytesDownloaded	The count of bytes downloaded in this request
DownloadDuration	The duration of the download in seconds

DECLARE_DELEGATE_TwoParams() [1/2]

DECLARE_DELEGATE_TwoParams	(	FBackgroundHttpRequestCompleteDelegate	,
		FBackgroundHttpRequestPtr	,
		bool
	)

Delegate called when a Background Http request completes

Parameters

Request	original Background Http request that started things
Response	response received from the server if a successful connection was established

DECLARE_DELEGATE_TwoParams() [2/2]

DECLARE_DELEGATE_TwoParams	(	FBackgroundHttpRequestMetricsExtendedDelegate	,
		FBackgroundHttpRequestPtr	,
		FBackgroundHttpRequestMetricsExtended
	)

Delegate called when a Background Http request extended metrics are ready

Parameters

Request	Background Http Request for which the metrics were calculated
BackgroundHttpRequestMetricsExtended	struct containing all the metrics

LexToString()

const TCHAR * LexToString ( EBackgroundHTTPPriority  InType )

inline

LexTryParseString()

bool LexTryParseString ( EBackgroundHTTPPriority &  OutMode, const TCHAR *  InBuffer  )

inline