Navigation
API > API/Plugins > API/Plugins/WebAPI
Common functionality and top-level parent for shared objects.
| Name | UWebAPISubsystem |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPI/Public/WebAPISubsystem.h |
| Include Path | #include "WebAPISubsystem.h" |
Syntax
UCLASS ()
class UWebAPISubsystem :
public UEngineSubsystem,
public FTickableGameObject,
public FWebAPIHttpRequestHandlerInterface ,
public FWebAPIHttpResponseHandlerInterface
Inheritance Hierarchy
- FWebAPIHttpRequestHandlerInterface → UWebAPISubsystem
- FWebAPIHttpResponseHandlerInterface → UWebAPISubsystem
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEngineSubsystem → UWebAPISubsystem
- FTickableObjectBase → FTickableGameObject → UWebAPISubsystem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWebAPISubsystem() |
WebAPISubsystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUsePooling | bool | WebAPISubsystem.h | ||
| HostRequestBuffer | TMap< FString, TArray< TSharedRef< IHttpRequest > > > | Requests retained per host for retry when response code indicates an auth error. | WebAPISubsystem.h | |
| OperationPool | TMap< FName, FWebAPIPooledOperation > | WebAPISubsystem.h |
|
|
| RequestBuffer | TArray< TSharedRef< IHttpRequest > > | Requests to process. | WebAPISubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
WebAPISubsystem.h | ||
virtual TStatId GetStatId() |
WebAPISubsystem.h | ||
virtual UWorld * GetTickableGameObjectWorld() |
FTickableGameObject implementation Begin. | WebAPISubsystem.h | |
virtual ETickableTickType GetTickableTickType() |
WebAPISubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
WebAPISubsystem.h | ||
TFuture< TTuple< TSharedPtr< IHttpResponse, ESPMode::ThreadSafe >, bool > > MakeHttpRequest
(
const FString& InVerb, |
Convenience function to create a simple Http request. | WebAPISubsystem.h | |
TObjectPtr< OperationType > MakeOperation
(
const UWebAPIDeveloperSettings* InSettings |
Get or create pooled operation for the given OperationType. | WebAPISubsystem.h | |
TObjectPtr< UWebAPIOperationObject > MakeOperation
(
const UWebAPIDeveloperSettings* InSettings, |
Get or create pooled operation for the given OperationType. | WebAPISubsystem.h | |
void ReleaseOperation
(
const TObjectPtr< OperationType >& InOperation |
Returns the provided operation to the pool, making it available for re-use. | WebAPISubsystem.h | |
void ReleaseOperation
(
const TSubclassOf< UWebAPIOperationObject >& InClass, |
Returns the provided operation to the pool, making it available for re-use. | WebAPISubsystem.h | |
void RetryRequestsForHost
(
const FString& InHost |
Retry any failed and buffered requests for the given host. | WebAPISubsystem.h | |
virtual void Tick
(
float DeltaTime |
WebAPISubsystem.h |