AccelByte::FHttpRetrySchedulerBase Class Reference

Inheritance diagram for AccelByte::FHttpRetrySchedulerBase:

Public Member Functions
	DECLARE_DELEGATE (FBearerAuthRejected)
	DECLARE_MULTICAST_DELEGATE (FBearerAuthRejectedMulticast)
	DECLARE_DELEGATE_OneParam (FBearerAuthRefreshed, FString const &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FBearerAuthRefreshedMulticast, FString const &)
	DECLARE_DELEGATE_RetVal_OneParam (EAccelByteTaskState, FHttpResponseCodeHandler, int32)
	A delegate to handle specified HTTP status code when the HTTP request succeeded and then will return a task state as the next command for the scheduler to do various things on the task that track the HTTP request.
virtual void	InitializeRateLimit ()=0
virtual FAccelByteTaskPtr	ProcessRequest (FHttpRequestPtr Request, const FHttpRequestCompleteDelegate &CompleteDelegate, double RequestTime)=0
virtual FAccelByteTaskPtr	ProcessRequest (FHttpRequestPtr Request, TSharedPtr< FJsonObject > Content, const FHttpRequestCompleteDelegate &CompleteDelegate, double RequestTime, bool bOmitBlankValues=false)=0
virtual void	SetBearerAuthRejectedDelegate (FBearerAuthRejected const &BearerAuthRejected)=0
virtual FDelegateHandle	AddBearerAuthRejectedDelegate (FBearerAuthRejected const &BearerAuthRejected)=0
virtual bool	RemoveBearerAuthRejectedDelegate (FDelegateHandle const &BearerAuthRejectedHandle)=0
virtual void	BearerAuthRejected ()=0
virtual void	PauseBearerAuthRequest ()=0
virtual void	ResumeBearerAuthRequest (const FString &AccessToken)=0
virtual FDelegateHandle	AddBearerAuthRefreshedDelegate (FBearerAuthRefreshed const &BearerAuthRefreshed)=0
virtual bool	RemoveBearerAuthRefreshedDelegate (FDelegateHandle const &BearerAuthRefreshedHandle)=0
virtual void	Startup ()=0
virtual void	Shutdown ()=0
virtual bool	PollRetry (double Time)=0
virtual Core::FAccelByteHttpCache &	GetHttpCache ()=0

Static Public Member Functions
static void	SetHttpResponseCodeHandlerDelegate (EHttpResponseCodes::Type StatusCode, const FHttpResponseCodeHandler &Handler)
static bool	RemoveHttpResponseCodeHandlerDelegate (EHttpResponseCodes::Type StatusCode)
static TMap< EHttpResponseCodes::Type, FHttpResponseCodeHandler >	GetHttpResponseCodeHandlerDelegate ()
static void	SetHeaderNamespace (const FString &Value)
static void	SetHeaderSDKVersion (const FString &Value)
static void	SetHeaderOSSVersion (const FString &Value)
static void	SetHeaderGameClientVersion (const FString &Value)

Static Public Attributes
static int	InitialDelay = 1
static int	MaximumDelay = 30
static int	TotalTimeout = 10
static int	TotalTimeoutIncludingRetries = 60
static int	PauseTimeout = 60
static constexpr uint32	DefaultRateLimit = 6

Static Protected Attributes
static TMap< EHttpResponseCodes::Type, FHttpResponseCodeHandler >	ResponseCodeDelegates {}
static FString	HeaderNamespace = TEXT("")
static FString	HeaderSDKVersion = TEXT("")
static FString	HeaderOSSVersion = TEXT("")
static FString	HeaderGameClientVersion = TEXT("")
static int32	RateLimit = FHttpRetrySchedulerBase::DefaultRateLimit

Member Function Documentation

DECLARE_DELEGATE_RetVal_OneParam()

AccelByte::FHttpRetrySchedulerBase::DECLARE_DELEGATE_RetVal_OneParam	(	EAccelByteTaskState	,
		FHttpResponseCodeHandler	,
		int32	)

A delegate to handle specified HTTP status code when the HTTP request succeeded and then will return a task state as the next command for the scheduler to do various things on the task that track the HTTP request.

• Completed, CancelledUAccelByteBlueprintsCredentials and Failed state will finish the task
• Running, Pending and Retrying state will retry the task
• Paused state will pause the task

Parameters

StatusCode

The HTTP status code that will be handled

Returns

EAccelByteTaskState The next state