description: Can be used to enforce tracking even when stereo rendering is disabled. The default implementation does not allow enforcing tracking and ignores the argument.

code: virtual void SetHeadTrackingEnforced ( bool bEnabled )


description: Sets base position of the HMD.

module: HeadMountedDisplay

code: virtual void SetBasePosition ( const FVector & BasePosition )


description: Sets tracking origin (either 'eye'-level or 'floor'-level).

code: void SetTrackingOrigin ( [EHMDTrackingOrigin::Type](API\Runtime\HeadMountedDisplay\EHMDTrackingOrigin__Type) NewOrigin )


description: Sets base orientation by setting yaw, pitch, roll, assuming that this is forward direction. Position is not changed.

code: virtual void SetBaseRotation ( const FRotator & BaseRot )


description: Refreshes the system's known tracking-to-world transform. Helpful for clients if they change the world's representation of the XR origin, or if they want to override the system calculated transform - calling this will update the known transform returned byGetTrackingToWorldTransform().

code: void UpdateTrackingToWorldTransform ( const FTransform & TrackingToWorldOverride )


description: Called after calibration to attempt to pull the internal tracker (e.g. HMD tracking) in line with the external tracker (e.g. mocap tracker). This will set the internal tracker's base offset and rotation to match and realign the two systems. This can be called every tick, or whenever realignment is desired. Note that this may cause choppy movement if the two systems diverge relative to each other, or a big jump if called infrequently when there has been significant drift

code: virtual void UpdateExternalTrackingPosition ( const FTransform & ExternalTrackingTransform )


className: IXRTrackingSystem

description: Main access point to an XR tracking system. Use it to enumerate devices and query their poses.

code: class IXRTrackingSystem : public [IModularFeature](API\Runtime\Core\Features\IModularFeature), public [IXRSystemIdentifier](API\Runtime\HeadMountedDisplay\IXRSystemIdentifier)


code: uint32 Capacity() const


code: void InsertAt ( uint32 Index, const ElementType & Element )


code: ElementType & Add ( const ElementType & Element )


description: NOTE: Will clamp to the oldest value available if the buffer isn't full and the index is larger than the number of values buffered.

code: ElementType & operator[] ( uint32 Index )


code: const ElementType & operator[] ( uint32 Index ) const


code: void Resize ( uint32 NewCapacity )


code: TCircularHistoryBuffer ( uint32 InitialCapacity )


className: TCircularHistoryBuffer

description: TCircularHistoryBufferModeled after TCircularBuffer/Queue, but resizable with it's own stack-style way of indexing (0 = most recent value added)

code: template<typename ElementType> class TCircularHistoryBuffer


description: Interpret a HandKeypoint as an int input

code: static int32 Conv_HandKeypointToInt32 ( EHandKeypoint input )


className: UHandKeypointConversion

code: class UHandKeypointConversion : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: This is called concurrently on multiple threads (but never the same component concurrently)

code: virtual void CreateRenderState_Concurrent ( [FRegisterComponentContext](API\Runtime\Engine\Components\FRegisterComponentContext) * Context )


className: EModelLoadStatus

code: enum EModelLoadStatus { Unloaded, Pending, InProgress, Complete, }


className: FActivateVisualizationComponent

description: Delegate for activation of XRDeviceVisualizationComponent.

code: typedef TMulticastDelegate_OneParam< void, bool > FActivateVisualizationComponent


description: If the motion tracking system provides angular velocity at this time OutAngularVelocity will be that velocity in deg/s in unreal world space and the function will return true. Note that it is not difficult to rotate a controller at more than 0.5 or 1 rotation per second briefly and some mathmatical operations(such as conversion to quaternion) lose rotations beyond 180 degrees or 360 degrees.. In some cases that is OK becuase the resulting final rotation is the same, but in some cases it would generate incorrect results. If angular velocity is unavailable it will return false.

code: bool GetAngularVelocity ( FRotator & OutAngularVelocity ) const


description: If the motion tracking system provides linear acceleration at this time the vector will be that acceleration in cm/(s^2) in unreal world space and the function will return true. If acceleration is unavailable it will return false.

code: bool GetLinearAcceleration ( FVector & OutLinearAcceleration ) const


description: If the motion tracking system provides linear velocity at this time the vector will be that velocity in cm/s in unreal world space and the function will return true. If velocity is unavailable it will return false.

code: bool GetLinearVelocity ( FVector & OutLinearVelocity ) const


description: Returns the value of a custom parameter on the current in use Motion Controller (see member InUseMotionController). Only valid for the duration of OnMotionControllerUpdated.

code: float GetParameterValue ( [FName](API\Runtime\Core\UObject\FName) InName, bool & bValueFound )


code: FVector GetHandJointPosition ( int jointIndex, bool & bValueFound )


description: Initializes the component. Occurs at level startup or actor spawn. This is before BeginPlay (Actor or Component). All Components in the level will be Initialized on load before any Actor/Component gets BeginPlay Requires component to be registered, and bWantsInitializeComponent to be true.

code: virtual void InitializeComponent()


description: Whether or not this component had a valid tracked device this frame

code: bool IsTracked() const


className: OnActivateVisualizationComponent


description: Called when a component is destroyed

code: virtual void OnComponentDestroyed ( bool bDestroyingHierarchy )


description: Callback for asynchronous display model loads (to set materials, etc.)

code: void OnDisplayModelLoaded ( [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) * DisplayComponent )


description: Blueprint Implementable function for responding to updated data from a motion controller (so we can use custom parameter values from it)

code: void OnMotionControllerUpdated()


description: Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

code: virtual void OnRegister()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: This is called when a property is about to be modified externally

code: virtual void PreEditChange ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyAboutToChange )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetAssociatedPlayerIndex ( const int32 NewPlayer )


description: Deprecated* SetCustomDisplayMesh is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.

code: void SetCustomDisplayMesh ( [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * NewDisplayMesh )


description: Deprecated* SetDisplayModelSource is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.

code: void SetDisplayModelSource ( const [FName](API\Runtime\Core\UObject\FName) NewDisplayModelSource )


description: Deprecated* SetShowDeviceModel is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.

code: void SetShowDeviceModel ( const bool bShowControllerModel )


description: The following private properties/members are now deprecated and will be removed in later versions.

code: void RefreshDisplayComponent ( const bool bForceDestroy )


code: void SetTrackingMotionSource ( const [FName](API\Runtime\Core\UObject\FName) NewSource )


code: void SetTrackingSource ( const EControllerHand NewSource )


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


code: UMotionControllerComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UMotionControllerComponent

code: class UMotionControllerComponent : public [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent)

bDisableLowLatencyUpdate

type: uint32:  1

description: If false, render transforms within the motion controller hierarchy will be updated a second time immediately before rendering.

CurrentTrackingStatus

type: ETrackingStatus

description: The tracking status for the device (e.g. full tracking, inertial tracking only, no tracking)

DisplayComponent

type: TObjectPtr<UPr...

DisplayDeviceId

type: FXRDeviceId

DisplayModelLoadState

type: EModelLoadStatu...

InUseMotionController

type: IMotionControll...

description: Cached Motion Controller that can be read by GetParameterValue. Only valid for the duration of OnMotionControllerUpdated.

MotionSource

type: FName

description: Defines which pose this component should receive from the OpenXR Runtime.

PlayerIndex

description: Which player index this motion controller should automatically follow


description: This is called concurrently on multiple threads (but never the same component concurrently)


description: Add task to be ran on the game thread next tick

module: HTTP

code: void AddGameThreadTask ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> && Task )


description: Add task to be ran on the http thread next tick

code: void AddHttpThreadTask ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> && Task )


description: Adds an Http request instance to the manager for tracking/ticking Manager should always have a list of requests currently being processed

code: void AddRequest ( const FHttpRequestRef & Request )


description: Add a http request to be executed on the http thread

code: void AddThreadedRequest ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< IHttpThreadedRequest, ESPMode::ThreadSafe > & Request )


description: Broadcast that a non-threaded HTTP request is complete. Called automatically internally for threaded requests. Called explicitly by non-threaded requests

code: void BroadcastHttpRequestCompleted ( const FHttpRequestRef & Request )


description: Mark a threaded http request as cancelled to be removed from the http thread

code: void CancelThreadedRequest ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< IHttpThreadedRequest, ESPMode::ThreadSafe > & Request )


description:
Create a new correlation id for a request
The new correlationid string


description:
Create HTTP thread object
the HTTP thread object

code: virtual FHttpThreadBase * CreateHttpThread()


code: FHttpFlushTimeLimit &40; double InSoftLimitSeconds, double InHardLimitSeconds &41;


className: FHttpFlushTimeLimit

code: struct FHttpFlushTimeLimit

HardLimitSeconds

type: double

description: After we hit the soft time limit and cancel the requests, we wait some additional time for the canceled requests to go away.

SoftLimitSeconds

description: Designates the amount of time we will wait during a flush before we try to cancel the request.


description: Block until all pending requests are finished processing

code: void Flush ( EHttpFlushReason FlushReason )


description: Tick called during Flush

code: virtual void FlushTick ( float DeltaSeconds )


description:
Get the default method for creating new correlation ids for a request
The default correlationid creation method


description: List all of the Http requests currently being processed

code: void DumpRequests ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar ) const


description: Initialize

code: void Initialize()


description: Inform that HTTP Manager that we have completed a fork(). Must be called in both the client and parent process

code: virtual void OnAfterFork()


description:
Determine if the domain is allowed to be accessed
true if domain is allowed

code: bool IsDomainAllowed ( const [FString](API\Runtime\Core\Containers\FString) & Url ) const


description:
Find an Http request in the lists of current valid requests
true if the request is being tracked, false if not

code: bool IsValidRequest ( const [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest) * RequestPtr ) const


description: Inform that HTTP Manager that we are about to fork(). Will block to flush all outstanding http requests

code: virtual void OnBeforeFork()


description: Inform the HTTP Manager that we finished ticking right after forking. Only called on the forked process

code: virtual void OnEndFramePostFork()


description: Removes an Http request instance from the manager Presumably it is done being processed

code: void RemoveRequest ( const FHttpRequestRef & Request )


className: RequestLock

description: Used to lock access to add/remove/find requests

code: static FCriticalSection RequestLock;


description: This method allows you to override the Engine default method.

code: void SetCorrelationIdMethod ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [FString](API\Runtime\Core\Containers\FString)()> InCorrelationIdMethod )


code: void SetRequestAddedDelegate ( const FHttpManagerRequestAddedDelegate & Delegate )


code: void SetRequestCompletedDelegate ( const FHttpManagerRequestCompletedDelegate & Delegate )


description: Set url request filter through code, instead of setting it through config.

code: void SetURLRequestFilter ( const [UE::Core::FURLRequestFilter](API\Runtime\Core\Misc\FURLRequestFilter) & InURLRequestFilter )


description: Shutdown logic should be called before quiting

code: void Shutdown()


description:
Method to check dynamic proxy setting support.
Whether this http implementation supports dynamic proxy setting.

code: virtual bool SupportsDynamicProxy() const


description:
FTSTickercallback
false if no longer needs ticking

code: virtual bool Tick ( float DeltaSeconds )


description: Update configuration. Called when config has been updated and we need to apply any changes.

code: virtual void UpdateConfigs()


description: Constructor

code: FHttpManager()


description: Destructor

code: virtual ~FHttpManager()


description: Add a default header to be appended to future requests If a request already specifies this header, then the defaulted version will not be used

code: void AddDefaultHeader ( const [FString](API\Runtime\Core\Containers\FString) & HeaderName, const [FString](API\Runtime\Core\Containers\FString) & HeaderValue )


description:
Instantiates a new Http request for the current platform
new Http request instance

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > CreateRequest()


description:
Handle exec commands starting with "HTTP"
true if the handler consumed the input, false to continue searching handlers

code: virtual bool Exec_Runtime ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [FHttpModule](API\Runtime\HTTP\FHttpModule) & Get()


description: the list of domains allowed to be visited in a shipping build

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetAllowedDomains() const


description:
Get the default headers that are appended to every request
the default headers

code: const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & GetDefaultHeaders() const


description: timeout in seconds to establish the connection

code: float GetHttpConnectionTimeout() const


description: min delay time for each http request

code: float GetHttpDelayTime() const


description: the domains which won't use proxy even if ProxyAddress is set

code: const [FString](API\Runtime\Core\Containers\FString) & GetHttpNoProxy() const


description: Duration between explicit tick calls when running an event loop http thread.


description:
Only meant to be used by Http request/response implementations
Http request manager used by the module


description: max number of simultaneous connections to a specific server


className: FHttpManager

description: Manages Http request that are currently being processed

code: class FHttpManager : public [FTSTickerObjectBase](API\Runtime\Core\Containers\FTSTickerObjectBase)

bFlushing

type: bool

description: This variable is set to true inFlush(EHttpFlushReason), and prevents new Http requests from being launched.

CorrelationIdMethod

type: TFunction<FStr...

description: This method will be called to generate a CorrelationId on all requests being sent if one is not already set

FlushTimeLimitsMap

type: TMap< EHttpFlus...

GameThreadQueue

type: TQueue<TFuncti...

description: Queue of tasks to run on the game thread

RequestAddedDelegate

type: FHttpManagerReq...

description: Delegate that will get called once request added

RequestCompletedDelegate

description: Delegate that will get called when a request completes

Requests

type: TArray< FHttpRe...

description: List of Http requests that are actively being processed

Thread

type: FHttpThreadBase...

URLRequestFilter

description: Url request filter, if specified in the config, it will launch http request only when the url is in the allowlist


description: timeout in seconds to receive a response on the connection

code: float GetHttpReceiveTimeout() const


description: timeout in seconds to send a request on the connection

code: float GetHttpSendTimeout() const


description: Target tick rate of an active http thread


description: Minimum sleep time of an active http thread


description: Minimum sleep time when idle, waiting for requests


description: Target tick rate of an idle http thread


description: timeout in seconds for the entire http request to complete

code: float GetHttpTimeout() const


description: max read buffer size for http requests

code: int32 GetMaxReadBufferSize() const


description: The current proxy address.

code: const [FString](API\Runtime\Core\Containers\FString) & GetProxyAddress() const


description: Exec command handlers

code: bool HandleHTTPCommand ( const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: true if http requests are enabled

code: bool IsHttpEnabled() const


description: true if null http is being used

code: bool IsNullHttpEnabled() const


description: Set the target tick rate of an active http thread

code: void SetHttpThreadActiveFrameTimeInSeconds ( float InHttpThreadActiveFrameTimeInSeconds )


description: Set the min delay time for each http request

code: void SetHttpDelayTime ( float InHttpDelayTime )


description: Set the minimum sleep time of an active http thread

code: void SetHttpThreadActiveMinimumSleepTimeInSeconds ( float InHttpThreadActiveMinimumSleepTimeInSeconds )


description: Set the target tick rate of an idle http thread

code: void SetHttpThreadIdleFrameTimeInSeconds ( float InHttpThreadIdleFrameTimeInSeconds )


description: Sets timeout in seconds for the entire http request to complete

code: void SetHttpTimeout ( float TimeOutInSec )


description: Set the minimum sleep time when idle, waiting for requests

code: void SetHttpThreadIdleMinimumSleepTimeInSeconds ( float InHttpThreadIdleMinimumSleepTimeInSeconds )


description: Sets the maximum size for the read buffer

code: void SetMaxReadBufferSize ( int32 SizeInBytes )


description: Setter for the proxy address.

code: void SetProxyAddress ( const [FString](API\Runtime\Core\Containers\FString) & InProxyAddress )


description: Toggle null http implementation

code: void ToggleNullHttp ( bool bEnabled )


className: Singleton

description: Singleton for the module while loaded and available

code: static [FHttpModule](API\Runtime\HTTP\FHttpModule) * Singleton = NULL;


description: Update all config-based values

code: void UpdateConfigs()


description:
Method to check dynamic proxy setting support.
Whether this http implementation supports dynamic proxy setting.

code: bool SupportsDynamicProxy() const


className: FHttpModule

description: Module for Http request implementations Use FHttpFactory to create a new Http request

code: class FHttpModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


description: Appends to the value already set in the header. If there is already content in that header, a comma delimiter is used. If the header is as of yet unset, the result is the same as calling SetHeader Content-Length is the only header set for you. Also see:SetHeader()

code: virtual void AppendToHeader ( const [FString](API\Runtime\Core\Containers\FString) & HeaderName, const [FString](API\Runtime\Core\Containers\FString) & AdditionalHeaderValue )


description: Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used.

code: virtual void ClearTimeout()


description: Get the content payload of the request or response.

code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetContent() const


description:
Return all headers in an array in "Name: Value" format.
the header array of strings

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAllHeaders() const


description:
Shortcut to get the Content-Type header value (if available)
the content type.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetContentType() const


description:
Shortcut to get the Content-Length header value. Will not always return non-zero. If you want the real length of the payload, get the payload and check it's length.
the content length (if available)

code: virtual uint64 GetContentLength() const


description:
Get thread policy about which thread to complete this request
The thread policy

code: virtual EHttpRequestDelegateThreadPolicy GetDelegateThreadPolicy() const


description:
Gets the time that it took for the server to fully respond to the request.
elapsed time in seconds.

code: virtual float GetElapsedTime() const


description: Gets the value of a header, or empty string if not found.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetHeader ( const [FString](API\Runtime\Core\Containers\FString) & HeaderName ) const


description:
Get the associated Response
the response

code: virtual const FHttpResponsePtr GetResponse() const


description:
Get the current status of the request being processed
the current status

code: virtual [EHttpRequestStatus::Type](API\Runtime\HTTP\Interfaces\EHttpRequestStatus__Type) GetStatus() const


description:
Gets the optional timeout in seconds for this entire HTTP request to complete. If valid, this value overrides the default HTTP timeout set via FHttpModule::SetTimeout().
the timeout for this HTTP request instance, in seconds

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< float > GetTimeout() const


description:
Get the URL used to send the request.
the URL string.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetURL() const


description:
Gets an URL parameter. expected format is ?Key=Value&Key=Value... If that format is not used, this function will not work.
the parameter value string.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetURLParameter ( const [FString](API\Runtime\Core\Containers\FString) & ParameterName ) const


description:
Gets the verb (GET, PUT, POST) used by the request.
the verb string

code: virtual [FString](API\Runtime\Core\Containers\FString) GetVerb() const


description: Sets the content of the request (optional data). Usually only set for POST requests.

code: virtual void SetContent ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & ContentPayload )


description: This version lets the API take ownership of the payload directly, helpful for larger payloads.

code: virtual void SetContent ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && ContentPayload )


description:
Sets the content of the request to stream from a file.
True if the file is valid and will be used to stream the request. False otherwise.

code: virtual bool SetContentAsStreamedFile ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
Sets the content of the request to stream directly from an archive. NOTE: The Stream->Serialize will be called from another thread other than the game thread
True if the archive can be used to stream the request. False otherwise.

code: virtual bool SetContentFromStream ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchive](API\Runtime\Core\Serialization\FArchive), ESPMode::ThreadSafe > Stream )


description: Sets the content of the request as a string encoded as UTF8.

code: virtual void SetContentAsString ( const [FString](API\Runtime\Core\Containers\FString) & ContentString )


description: Set thread policy about which thread to complete this request

code: virtual void SetDelegateThreadPolicy ( EHttpRequestDelegateThreadPolicy InThreadPolicy )


description:
NOTE: Once set, the data will no longer be cached in response,IHttpResponse::GetContent()andIHttpResponse::GetContentAsString()will return empty result. The Stream->Serialize will be called from another thread other than the game thread
True if the stream can be used. False otherwise.

code: virtual bool SetResponseBodyReceiveStream ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchive](API\Runtime\Core\Serialization\FArchive) > Stream )


description: Sets optional header info. SetHeader for a given HeaderName will overwrite any previous values Use AppendToHeader to append more values for the same header Content-Length is the only header set for you. Required headers depends on the request itself. Eg. "multipart/form-data" needed for a form post

code: virtual void SetHeader ( const [FString](API\Runtime\Core\Containers\FString) & HeaderName, const [FString](API\Runtime\Core\Containers\FString) & HeaderValue )


description: Sets an optional timeout in seconds for this entire HTTP request to complete. If set, this value overrides the default HTTP timeout set via FHttpModule::SetTimeout().

code: virtual void SetTimeout ( float InTimeoutSecs )


description: Sets the URL for the request Eg. (http://my.domain.com/something.ext?key=value&key2=value). Must be set before calling ProcessRequest.

code: virtual void SetURL ( const [FString](API\Runtime\Core\Containers\FString) & URL )


description: Sets the verb used by the request. Eg. (GET, PUT, POST) Should be set before calling ProcessRequest. If not specified then a GET is assumed.

code: virtual void SetVerb ( const [FString](API\Runtime\Core\Containers\FString) & Verb )


description: Used to tick the request

code: virtual void Tick ( float DeltaSeconds )


code: FHttpRequestAdapterBase ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > & InHttpRequest )


className: FHttpRequestAdapterBase

description: Adapter class forIHttpRequestabstract interface does not fully expose the wrapped interface in the base. This allows client defined marshalling of the requests when end point permissions are at issue.

code: class FHttpRequestAdapterBase : public [FHttpRequestImpl](API\Runtime\HTTP\GenericPlatform\FHttpRequestImpl)

HttpRequest

type: TSharedRef<IHt...


code: namespace FHttpRetrySystem { [RetryTimeoutRelativeSecondsType](API\Runtime\HTTP\RetryTimeoutRelativeSecondsType) FHttpRetrySystem::RetryTimeoutRelativeSeconds ( double Value ) }


code: namespace FHttpRetrySystem { [RetryLimitCountType](API\Runtime\HTTP\RetryLimitCountType) FHttpRetrySystem::RetryLimitCount ( uint32 Value ) }


code: namespace FHttpRetrySystem { template<typename IntrinsicType> IntrinsicType FHttpRetrySystem::TZero() }


code: namespace FHttpRetrySystem { template<> [RetryLimitCountType](API\Runtime\HTTP\RetryLimitCountType) FHttpRetrySystem::TZero< RetryLimitCountType >() }


className: FHttpRetrySystem::TZero< float >

code: namespace FHttpRetrySystem { template<> float FHttpRetrySystem::TZero< float >() }


code: namespace FHttpRetrySystem { template<> [RetryTimeoutRelativeSecondsType](API\Runtime\HTTP\RetryTimeoutRelativeSecondsType) FHttpRetrySystem::TZero< RetryTimeoutRelativeSecondsType >() }


description: Block the current process until all requests are flushed, or timeout has elapsed

code: void BlockUntilFlushed ( float TimeoutSec )


code: void CancelRequest ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FRequest](API\Runtime\HTTP\FRequest), ESPMode::ThreadSafe > & HttpRequest )


description: Create a new http request with retries

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FHttpRetrySystem::FRequest](API\Runtime\HTTP\FRequest), ESPMode::ThreadSafe > CreateRequest ( const [FRetryLimitCountSetting](API\Runtime\HTTP\FRetryLimitCountSetting) & InRetryLimitCountOverride, const [FRetryTimeoutRelativeSecondsSetting](API\Runtime\HTTP\FRetryTimeoutRelativeSecondsSett-) & InRetryTimeoutRelativeSecondsOverride, const [FRetryResponseCodes](API\Runtime\HTTP\FRetryResponseCodes) & InRetryResponseCodes, const [FRetryVerbs](API\Runtime\HTTP\FRetryVerbs) & InRetryVerbs, const [FRetryDomainsPtr](API\Runtime\HTTP\FRetryDomainsPtr) & InRetryDomains )


description: Mark that a request is being retried

code: void IncrementRetriedRequests&40;&41;


description: true if retry chances have not been exhausted

code: bool CanRetry ( const [FHttpRetryRequestEntry](API\Runtime\HTTP\FManager\FHttpRetryRequestEntry) & HttpRetryRequestEntry )


code: static FHttpLogVerbosityTracker & Get&40;&41;


description: Mark that a retried request is no longer being retried

code: void DecrementRetriedRequests&40;&41;


code: void OnConfigSectionsChanged &40; const FString & IniFilename, const TSet< FString > & SectionName &41;


description: Update settings from config

code: void UpdateSettingsFromConfig&40;&41;


code: FHttpRetryRequestEntry &40; TSharedRef< FRequest, ESPMode::ThreadSafe > & InRequest &41;


className: FHttpRetryRequestEntry

code: struct FHttpRetryRequestEntry

Request

type: TSharedRef<FRe...


description: number of seconds to lockout for

code: float GetLockoutPeriodSeconds ( const [FHttpRetryRequestEntry](API\Runtime\HTTP\FManager\FHttpRetryRequestEntry) & HttpRetryRequestEntry )


description: true if the retry request has timed out

code: bool HasTimedOut ( const [FHttpRetryRequestEntry](API\Runtime\HTTP\FManager\FHttpRetryRequestEntry) & HttpRetryRequestEntry, const double NowAbsoluteSeconds )


code: bool ProcessRequest ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FRequest](API\Runtime\HTTP\FRequest), ESPMode::ThreadSafe > & HttpRequest )


description: Retry an HTTP request

code: void RetryHttpRequest ( [FHttpRetryRequestEntry](API\Runtime\HTTP\FManager\FHttpRetryRequestEntry) & RequestEntry )


code: void SetRandomFailureRate ( float Value )


description: true if there is a no formal response to the request  return true if a variety of 5xx errors are the result of a formal response

code: bool ShouldRetry ( const [FHttpRetryRequestEntry](API\Runtime\HTTP\FManager\FHttpRetryRequestEntry) & HttpRetryRequestEntry )


description:
Updates the entries in the list of retry requests. Optional parameters are for future connection health assessment
true if there are no failures or retries

code: bool Update ( uint32 * FileCount, uint32 * FailingCount, uint32 * FailedCount, uint32 * CompletedCount )


description: FManager.

code: FManager ( const [FRetryLimitCountSetting](API\Runtime\HTTP\FRetryLimitCountSetting) & InRetryLimitCountDefault, const [FRetryTimeoutRelativeSecondsSetting](API\Runtime\HTTP\FRetryTimeoutRelativeSecondsSett-) & InRetryTimeoutRelativeSecondsDefault )


className: FManager

code: class FManager

RandomFailureRate

type: FRandomFailureR...

description: Default configuration for the retry system.

RequestList

type: TArray<FHttpRe...

RetryLimitCountDefault

type: FRetryLimitCoun...

RetryTimeoutRelativeSecondsDefault

type: FRetryTimeoutRe...


className: FRandomFailureRateSetting

code: typedef [TOptional](API\Runtime\Core\IO\TOptional)< float > FRandomFailureRateSetting


description: Called to cancel a request that is still being processed

code: virtual void CancelRequest()


code: void SetDefaultRetryLimit ( uint32 Value )


className: FHttpLogVerbosityTracker

code: class FHttpLogVerbosityTracker

NumRetriedRequests

description: Number of requests that are in a retried state. When this is non-zero, verbosity will be adjusted.

OriginalVerbosity

description: Verbosity to restore to when there are no requests being retried

TargetVerbosity

description: Config driven target verbosity to set to when requests are being retried.


className: Type

code: enum Type { NotStarted = 0, Processing, ProcessingLockout, Cancelled, FailedRetry, FailedTimeout, Succeeded, }


description: FRequest.


code: void HttpOnRequestProgress ( FHttpRequestPtr InHttpRequest, int32 BytesSent, int32 BytesRcv )


description: Move to the next retry domain from our RetryDomains

code: void MoveToNextRetryDomain()


description: Update our HTTP request's URL's domain from our RetryDomains

code: void SetUrlFromRetryDomains()


description:
Called to begin processing the request. OnProcessRequestComplete delegate is always called when the request completes or on error if it is bound. A request can be re-used but not while still being processed.
if the request was successfully started.

code: virtual bool ProcessRequest()


code: FRequest ( class [FManager](API\Runtime\HTTP\FManager) & InManager, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > & HttpRequest, const [FRetryLimitCountSetting](API\Runtime\HTTP\FRetryLimitCountSetting) & InRetryLimitCountOverride, const [FRetryTimeoutRelativeSecondsSetting](API\Runtime\HTTP\FRetryTimeoutRelativeSecondsSett-) & InRetryTimeoutRelativeSecondsOverride, const [FRetryResponseCodes](API\Runtime\HTTP\FRetryResponseCodes) & InRetryResponseCodes, const [FRetryVerbs](API\Runtime\HTTP\FRetryVerbs) & InRetryVerbs, const [FRetryDomainsPtr](API\Runtime\HTTP\FRetryDomainsPtr) & InRetryDomains )


className: FRequest

description: ClassFRequestis what the retry system accepts as inputs

code: class FRequest : public [FHttpRequestAdapterBase](API\Runtime\HTTP\FHttpRequestAdapterBase)

OriginalUrl

type: FString

description: The original URL before replacing anything from RetryDomains

RetryDomains

type: FRetryDomainsPt...

RetryDomainsIndex

description: The current index in RetryDomains we are attempting

RetryManager

type: FManager&

RetryResponseCodes

type: FRetryResponseC...

RetryVerbs

type: FRetryVerbs


code: FRetryDomains ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > && InDomains )


className: FRetryDomains

code: struct FRetryDomains

ActiveIndex

type: TAtomic< int32 ...

description: Indexinto Domains to attempt Domains are cycled through on some errors, and when we succeed on one domain, we remain on that domain until that domain results in an error

Domains

type: constTArray<F...

description: The domains to use


className: FRetryDomainsPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FRetryDomains](API\Runtime\HTTP\FRetryDomains), ESPMode::ThreadSafe > FRetryDomainsPtr


className: FRetryLimitCountSetting

code: typedef [TOptional](API\Runtime\Core\IO\TOptional)< [RetryLimitCountType](API\Runtime\HTTP\RetryLimitCountType) > FRetryLimitCountSetting


className: FRetryResponseCodes

code: typedef [TSet](API\Runtime\Core\Containers\TSet)< int32 > FRetryResponseCodes


className: FRetryVerbs

code: typedef [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > FRetryVerbs


code: void AddPlatformComment ( const [FString](API\Runtime\Core\Containers\FString) & InComment )


code: void AddProjectComment ( const [FString](API\Runtime\Core\Containers\FString) & InComment )


description: Get the builder version. The version is used for tracking app changes to the default user agent and is not included in the user agent string.

code: uint32 GetAgentVersion() const


description: Build the user agent string. Passing a filter will limit the comments to only those allowed. Passing nullptr for a filter implies that all comments are allowed.

code: [FString](API\Runtime\Core\Containers\FString) BuildUserAgentString ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > * AllowedProjectCommentsFilter, const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > * AllowedPlatformCommentsFilter ) const


code: void SetPlatformName ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName )


code: void SetPlatformVersion ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformVersion )


code: void SetProjectName ( const [FString](API\Runtime\Core\Containers\FString) & InProjectName )


code: void SetProjectVersion ( const [FString](API\Runtime\Core\Containers\FString) & InProjectVersion )


className: FDefaultUserAgentBuilder

description: Utility structure to help with building the HTTP user agent string.

code: class FDefaultUserAgentBuilder


description: Add a comment to be included in the project section of the default User-Agent string.

code: static void AddDefaultUserAgentProjectComment ( const [FString](API\Runtime\Core\Containers\FString) & Comment )


description:
Creates a new Http request instance for the current platform
request object

code: static [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest) * ConstructRequest()


description:
Creates a platform-specific HTTP manager.
nullptr if default implementation is to be used

code: static [FHttpManager](API\Runtime\HTTP\FHttpManager) * CreatePlatformHttpManager()


description: Add a comment to be included in the platform section of the default User-Agent string.

code: static void AddDefaultUserAgentPlatformComment ( const [FString](API\Runtime\Core\Containers\FString) & Comment )


description:
The default User-Agent is built in the format "project/version (comments) platform/OS version (comments)"
the default User-Agent string that requests should use.


description: Gets a copy of the values used to build the default user agent string. Used for modifying default user agent values before sending HTTP requests.


code: static [FString](API\Runtime\Core\Containers\FString) EscapeUserAgentString ( const [FString](API\Runtime\Core\Containers\FString) & UnescapedString )


description:
Get the version of the default user agent. The version is incremented any time the default user agent is changed. Used to invalidate any cached user agent value.
the current version of the default user agent.


description:
Utility for escaping a string used in the HTTP user agent. Removes disallowed characters.
optionalFString: If unset: we are unable to get information from the operating system. If set: the proxy address set by the operating system (may be blank)

code: static [TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > GetOperatingSystemProxyAddress()


description:
Get the mime type for the file
the mime type for the file.

code: static [FString](API\Runtime\Core\Containers\FString) GetMimeType ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


description:
Returns the domain portion of the URL, e.g., "a.b.c" of "http://a.b.c:d/e"
the domain of the specified URL

code: static [FString](API\Runtime\Core\Containers\FString) GetUrlDomain ( const FStringView Url )


description:
Returns the domain and port portion of the URL, e.g., "a.b.c:d" of "http://a.b.c:d/e"
the domain and port of the specified URL

code: static [FString](API\Runtime\Core\Containers\FString) GetUrlDomainAndPort ( const FStringView Url )


description: Extract the Path portion of a URL, optionally including the Query String, and optionally including the Fragment (when also including the query string.) The return value will always contain a leading forward slash, even if no path is found. If bIncludeFragment is set true, bIncludeQueryString must also be true

code: static [FString](API\Runtime\Core\Containers\FString) GetUrlPath ( const FStringView Url, const bool bIncludeQueryString, const bool bIncludeFragment )


description:
Extract the URL-Decoded value of the specified ParameterName from Url. An unset return means the parameter was not present in Url, while an empty value means it was present, but had no value.
If ParameterName was found, the string value of its value (in URL Decoded format), otherwise the return value is unset

code: static [TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > GetUrlParameter ( const FStringView Url, const FStringView ParameterName )


description: Extract the Port part of a URL, or an unset object if there was non specified. Example: "http://example.org:23/" would return 23, while "https://example.org/" would return an unset object

code: static [TOptional](API\Runtime\Core\IO\TOptional)< uint16 > GetUrlPort ( const FStringView Url )


description:
Returns the < >...etc encoding for strings between HTML elements.
The html encoded string

code: static [FString](API\Runtime\Core\Containers\FString) HtmlEncode ( const FStringView UnencodedString )


description: Platform initialization step

code: static void Init()


description:
Check the protocol of the provided URL to determine if this is for a secure connection (HTTPS, WSS, etc)
True if secure, false if insecure, unset if unknown

code: static [TOptional](API\Runtime\Core\IO\TOptional)< bool > IsSecureProtocol ( const FStringView Url )


description:
Check if getting proxy information from the current operating system is supported Useful for "Network Settings" type pages. GetProxyAddress may return an empty or populated string but that does not imply the operating system does or does not support proxies (or that it has been implemented here)
true if we are able to get proxy information from the current operating system, false if not


description: Helper function for checking if a byte array is in URL encoded format.

code: static bool IsURLEncoded ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Payload )


description:
Returns a decoded version of the percent-encoded passed in string
The decoded string

code: static [FString](API\Runtime\Core\Containers\FString) UrlDecode ( const FStringView EncodedString )


description: Platform shutdown step

code: static void Shutdown()


description:
Returns a percent-encoded version of the passed in string
The percent-encoded string

code: static [FString](API\Runtime\Core\Containers\FString) UrlEncode ( const FStringView UnencodedString )


className: FGenericPlatformHttp

description: Platform specific Http implementations Intended usage is to use FPlatformHttp instead ofFGenericPlatformHttp

code: class FGenericPlatformHttp


description:
Get thread policy about which thread to complete this request
The thread policy

code: virtual EHttpRequestDelegateThreadPolicy GetDelegateThreadPolicy() const


description: IHttpRequest.

code: virtual [EHttpRequestStatus::Type](API\Runtime\HTTP\Interfaces\EHttpRequestStatus__Type) GetStatus() const


description: Check if this request is valid or allowed, before actually process the request

code: bool PreCheck() const


description:
Check if a platform uses the HTTP thread
true if the platform uses threaded HTTP, false if not

code: static bool UsesThreadedHttp()


description: Set thread policy about which thread to complete this request

code: virtual void SetDelegateThreadPolicy ( EHttpRequestDelegateThreadPolicy InThreadPolicy )


className: FHttpRequestCommon

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

code: class FHttpRequestCommon : public [FHttpRequestImpl](API\Runtime\HTTP\GenericPlatform\FHttpRequestImpl)

CompletionStatus

type: EHttpRequestSta...

description: Current status of request being processed

DelegateThreadPolicy

type: EHttpRequestDel...

description: Thread policy about which thread to complete this request


description: Broadcast all of our response's headers as having been received Used when we don't know when we receive headers in our HTTP implementation

code: void BroadcastResponseHeadersReceived()


description: Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used.

code: virtual void ClearTimeout()


description:
Gets the optional timeout in seconds for this entire HTTP request to complete. If valid, this value overrides the default HTTP timeout set via FHttpModule::SetTimeout().
the timeout for this HTTP request instance, in seconds

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< float > GetTimeout() const


description: Delegate called to signal the receipt of a header. See FHttpRequestHeaderReceivedDelegate

code: virtual FHttpRequestHeaderReceivedDelegate & OnHeaderReceived()


description: IHttpRequest.

code: virtual FHttpRequestCompleteDelegate & OnProcessRequestComplete()


description: Delegate called to update the request/response progress. See FHttpRequestProgressDelegate

code: virtual FHttpRequestProgressDelegate & OnRequestProgress()


description: Delegate called when the request will be retried

code: virtual FHttpRequestWillRetryDelegate & OnRequestWillRetry()


description: Sets an optional timeout in seconds for this entire HTTP request to complete. If set, this value overrides the default HTTP timeout set via FHttpModule::SetTimeout().

code: virtual void SetTimeout ( float InTimeoutSecs )


className: FHttpRequestImpl

description: Contains implementation of some common functions that don't vary between implementation

code: class FHttpRequestImpl : public [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest)

HeaderReceivedDelegate

type: FHttpRequestHea...

description: Delegate that will get called for each new header received

OnRequestWillRetryDelegate

type: FHttpRequestWil...

description: Delegate that will get called when request will be retried

RequestCompleteDelegate

type: FHttpRequestCom...

description: Delegate that will get called once request completes or on any error

RequestProgressDelegate

type: FHttpRequestPro...

description: Delegate that will get called once per tick with bytes downloaded so far

TimeoutSecs

type: TOptional< floa...

description: Timeout in seconds for the entire HTTP request to complete


description:
Read part of the underlying request payload into an output buffer.
Returns the number of bytes copied into OutputBuffer

code: size_t FillOutputBuffer ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > OutputBuffer, size_t SizeAlreadySent )


code: size_t FillOutputBuffer ( void * OutputBuffer, size_t MaxOutputBufferSize, size_t SizeAlreadySent )


description: Return a reference to the underlying memory buffer. Only valid for in-memory request payloads

code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetContent() const


description: Get the total content length of the request payload in bytes

code: uint64 GetContentLength() const


description: Check if the request payload is URL encoded. This check is only performed for in-memory request payloads

code: bool IsURLEncoded() const


className: FRequestPayload

description: Abstraction that encapsulates the location of a request payload

code: class FRequestPayload


code: virtual size_t FillOutputBuffer ( void * OutputBuffer, size_t MaxOutputBufferSize, size_t SizeAlreadySent )


code: virtual size_t FillOutputBuffer ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > OutputBuffer, size_t SizeAlreadySent )


code: virtual uint64 GetContentLength() const


code: FRequestPayloadInFileStream ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchive](API\Runtime\Core\Serialization\FArchive), ESPMode::ThreadSafe > InFile )


code: virtual bool IsURLEncoded() const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetContent() const


code: virtual ~FRequestPayloadInFileStream()


className: FRequestPayloadInFileStream

code: class FRequestPayloadInFileStream : public [FRequestPayload](API\Runtime\HTTP\GenericPlatform\FRequestPayload)


code: FRequestPayloadInMemory ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Array )


code: FRequestPayloadInMemory ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && Array )


className: FRequestPayloadInMemory

code: class FRequestPayloadInMemory : public [FRequestPayload](API\Runtime\HTTP\GenericPlatform\FRequestPayload)


code: namespace EHttpRequestStatus { bool EHttpRequestStatus::IsFinished ( const [EHttpRequestStatus::Type](API\Runtime\HTTP\Interfaces\EHttpRequestStatus__Type) Value ) }


description: the stringified version of the enum passed in

code: namespace EHttpRequestStatus { const TCHAR * EHttpRequestStatus::ToString ( [EHttpRequestStatus::Type](API\Runtime\HTTP\Interfaces\EHttpRequestStatus__Type) EnumVal ) }


description: Enumerates the current state of an Http request

code: namespace EHttpRequestStatus { enum Type { NotStarted, Processing, Failed, Failed_ConnectionError, Succeeded, } }


description: The status code description

code: namespace EHttpResponseCodes { [FText](API\Runtime\Core\Internationalization\FText) EHttpResponseCodes::GetDescription ( [EHttpResponseCodes::Type](API\Runtime\HTTP\Interfaces\EHttpResponseCodes__Type) StatusCode ) }


description: true if the status code is an Ok response

code: namespace EHttpResponseCodes { bool EHttpResponseCodes::IsOk ( int32 StatusCode ) }


description: Response codes that can come back from an Http request

code: namespace EHttpResponseCodes { enum Type { Unknown = 0, Continue = 100, SwitchProtocol = 101, Ok = 200, Created = 201, Accepted = 202, Partial = 203, NoContent = 204, ResetContent = 205, PartialContent = 206, Ambiguous = 300, Moved = 301, Redirect = 302, RedirectMethod = 303, NotModified = 304, UseProxy = 305, RedirectKeepVerb = 307, BadRequest = 400, Denied = 401, PaymentReq = 402, Forbidden = 403, NotFound = 404, BadMethod = 405, NoneAcceptable = 406, ProxyAuthReq = 407, RequestTimeout = 408, Conflict = 409, Gone = 410, LengthRequired = 411, PrecondFailed = 412, RequestTooLarge = 413, UriTooLong = 414, UnsupportedMedia = 415, TooManyRequests = 429, RetryWith = 449, ServerError = 500, NotSupported = 501, BadGateway = 502, ServiceUnavail = 503, GatewayTimeout = 504, VersionNotSup = 505, } }


code: virtual void Serialize ( void * V, int64 Length )


code: FArchiveWithDelegate ( FHttpRequestStreamDelegate InStreamDelegate )


className: FArchiveWithDelegate

description: Delegate version ofFArchive, for streaming interface

code: class FArchiveWithDelegate : public [FArchive](API\Runtime\Core\Serialization\FArchive)


description:
Return all headers in an array in "Name: Value" format.
the header array of strings

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAllHeaders() const


description: Get the content payload of the request or response.

code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetContent() const


description:
Shortcut to get the Content-Length header value. Will not always return non-zero. If you want the real length of the payload, get the payload and check it's length.
the content length (if available)

code: uint64 GetContentLength() const


description:
Shortcut to get the Content-Type header value (if available)
the content type.


description: Gets the value of a header, or empty string if not found.

code: [FString](API\Runtime\Core\Containers\FString) GetHeader ( const [FString](API\Runtime\Core\Containers\FString) & HeaderName ) const


description:
Get the URL used to send the request.
the URL string.


description:
Gets an URL parameter. expected format is ?Key=Value&Key=Value... If that format is not used, this function will not work.
the parameter value string.

code: [FString](API\Runtime\Core\Containers\FString) GetURLParameter ( const [FString](API\Runtime\Core\Containers\FString) & ParameterName ) const


description: Destructor for overrides

code: virtual ~IHttpBase()


className: IHttpBase

description: Base interface for Http Requests and Responses.

code: class IHttpBase


description: Appends to the value already set in the header. If there is already content in that header, a comma delimiter is used. If the header is as of yet unset, the result is the same as calling SetHeader Content-Length is the only header set for you. Also see:SetHeader()

code: void AppendToHeader ( const [FString](API\Runtime\Core\Containers\FString) & HeaderName, const [FString](API\Runtime\Core\Containers\FString) & AdditionalHeaderValue )


description: Called to cancel a request that is still being processed

code: void CancelRequest()


description: Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used.

code: void ClearTimeout()


description:
Get thread policy about which thread to complete this request
The thread policy


description:
Gets the time that it took for the server to fully respond to the request.
elapsed time in seconds.

code: float GetElapsedTime() const


description:
Get the associated Response
the response

code: const FHttpResponsePtr GetResponse() const


description:
Get the current status of the request being processed
the current status


description:
Gets the optional timeout in seconds for this entire HTTP request to complete. If valid, this value overrides the default HTTP timeout set via FHttpModule::SetTimeout().
the timeout for this HTTP request instance, in seconds

code: [TOptional](API\Runtime\Core\IO\TOptional)< float > GetTimeout() const


description:
Gets the verb (GET, PUT, POST) used by the request.
the verb string


description: Delegate called to signal the receipt of a header. See FHttpRequestHeaderReceivedDelegate


description: Delegate called when the request is complete. See FHttpRequestCompleteDelegate


description: Delegate called to update the request/response progress. See FHttpRequestProgressDelegate


description: Delegate called when the request will be retried


description:
Called to begin processing the request. OnProcessRequestComplete delegate is always called when the request completes or on error if it is bound. A request can be re-used but not while still being processed.
if the request was successfully started.

code: bool ProcessRequest()


description: Sets the content of the request (optional data). Usually only set for POST requests.

code: void SetContent ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & ContentPayload )


description: This version lets the API take ownership of the payload directly, helpful for larger payloads.

code: void SetContent ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && ContentPayload )


description:
Sets the content of the request to stream from a file.
True if the file is valid and will be used to stream the request. False otherwise.

code: bool SetContentAsStreamedFile ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Sets the content of the request as a string encoded as UTF8.

code: void SetContentAsString ( const [FString](API\Runtime\Core\Containers\FString) & ContentString )


description:
Sets the content of the request to stream directly from an delegate. NOTE: The delegate will be called from another thread other than the game thread
True if the delegate can be used to stream the request. False otherwise.

code: bool SetContentFromStreamDelegate ( FHttpRequestStreamDelegate StreamDelegate )


description:
Sets the content of the request to stream directly from an archive. NOTE: The Stream->Serialize will be called from another thread other than the game thread
True if the archive can be used to stream the request. False otherwise.

code: bool SetContentFromStream ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchive](API\Runtime\Core\Serialization\FArchive), ESPMode::ThreadSafe > Stream )


description: Set thread policy about which thread to complete this request

code: void SetDelegateThreadPolicy ( EHttpRequestDelegateThreadPolicy InThreadPolicy )


description: Sets optional header info. SetHeader for a given HeaderName will overwrite any previous values Use AppendToHeader to append more values for the same header Content-Length is the only header set for you. Required headers depends on the request itself. Eg. "multipart/form-data" needed for a form post

code: void SetHeader ( const [FString](API\Runtime\Core\Containers\FString) & HeaderName, const [FString](API\Runtime\Core\Containers\FString) & HeaderValue )


description:
NOTE: Once set, the data will no longer be cached in response,IHttpResponse::GetContent()andIHttpResponse::GetContentAsString()will return empty result. The Stream->Serialize will be called from another thread other than the game thread
True if the stream can be used. False otherwise.

code: bool SetResponseBodyReceiveStream ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchive](API\Runtime\Core\Serialization\FArchive) > Stream )


description:
NOTE: Once set, the data will no longer be cached in response,IHttpResponse::GetContent()andIHttpResponse::GetContentAsString()will return empty result. The delegate will be called from another thread other than the game thread
True if the delegate can be used. False otherwise.

code: bool SetResponseBodyReceiveStreamDelegate ( FHttpRequestStreamDelegate StreamDelegate )


description: Sets an optional timeout in seconds for this entire HTTP request to complete. If set, this value overrides the default HTTP timeout set via FHttpModule::SetTimeout().

code: void SetTimeout ( float InTimeoutSecs )


description: Sets the URL for the request Eg. (http://my.domain.com/something.ext?key=value&key2=value). Must be set before calling ProcessRequest.

code: void SetURL ( const [FString](API\Runtime\Core\Containers\FString) & URL )


description: Sets the verb used by the request. Eg. (GET, PUT, POST) Should be set before calling ProcessRequest. If not specified then a GET is assumed.

code: void SetVerb ( const [FString](API\Runtime\Core\Containers\FString) & Verb )


description: Used to tick the request

code: void Tick ( float DeltaSeconds )


description: Destructor for overrides

code: virtual ~IHttpRequest()


className: IHttpRequest

description: Interface for Http requests (created using FHttpFactory)

code: class IHttpRequest : public [IHttpBase](API\Runtime\HTTP\Interfaces\IHttpBase), public [TSharedFromThis< IHttpRequest, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description:
Gets the response code returned by the requested server. See EHttpResponseCodes for known response codes
the response code.

code: int32 GetResponseCode() const


description: Destructor for overrides

code: virtual ~IHttpResponse()


className: IHttpResponse

description: Interface for Http responses that come back after starting an Http request

code: class IHttpResponse : public [IHttpBase](API\Runtime\HTTP\Interfaces\IHttpBase)


className: RetryLimitCountType

code: typedef uint32 RetryLimitCountType


className: RangeType

code: enum &123; RangeType = 0 &125;


description:
Returns the payload as a string, assuming the payload is UTF8.
the payload as a string.


code: static constexpr underlying_type &40; EHttpFlushReason &41;


className: TEnumRangeTraits< EHttpFlushReason >

code: template<> struct TEnumRangeTraits< EHttpFlushReason >


description:
Creates a new Http request instance for the current platform
request object

code: static [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest) * ConstructRequest()


description:
Creates a platform-specific HTTP manager.
NULL if default implementation is to be used

code: static [FHttpManager](API\Runtime\HTTP\FHttpManager) * CreatePlatformHttpManager()


description: Platform shutdown step

code: static void Shutdown()


description: Platform initialization step

code: static void Init()


module: HttpNetworkReplayStreaming

code: namespace EQueuedHttpRequestType { const TCHAR * EQueuedHttpRequestType::ToString ( [EQueuedHttpRequestType::Type](API\Runtime\HttpNetworkReplayStreaming\EQueuedHttpRequestType__Type) Type ) }


className: FUnixPlatformHttp

description: Platform specific Http implementations

code: class FUnixPlatformHttp : public [FGenericPlatformHttp](API\Runtime\HTTP\GenericPlatform\FGenericPlatformHttp)


code: namespace EQueuedHttpRequestType { enum Type { StartUploading, UploadingHeader, UploadingStream, StopUploading, StartDownloading, DownloadingHeader, DownloadingStream, RefreshingViewer, EnumeratingSessions, EnumeratingCheckpoints, UploadingCheckpoint, DownloadingCheckpoint, AddingUser, UploadingCustomEvent, EnumeratingCustomEvent, RequestEventData, UploadHeader, StopStreaming, KeepReplay, } }


code: FCachedResponse ( FHttpResponsePtr InResponse, const double InLastAccessTime )


className: FCachedResponse

code: class FCachedResponse

LastAccessTime

type: double

Response

type: FHttpResponsePt...


code: void AddCustomRequestToQueue ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FQueuedHttpRequest](API\Runtime\HttpNetworkReplayStreaming\FQueuedHttpRequest) > Request )


code: virtual void AddEvent ( const uint32 TimeInMS, const [FString](API\Runtime\Core\Containers\FString) & Group, const [FString](API\Runtime\Core\Containers\FString) & Meta, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Data )


code: virtual void AddOrUpdateEvent ( const [FString](API\Runtime\Core\Containers\FString) & Name, const uint32 TimeInMS, const [FString](API\Runtime\Core\Containers\FString) & Group, const [FString](API\Runtime\Core\Containers\FString) & Meta, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Data )


code: void AddRequestToQueue ( const [EQueuedHttpRequestType::Type](API\Runtime\HttpNetworkReplayStreaming\EQueuedHttpRequestType__Type) Type, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > Request, const int32 InMaxRetries, const float InRetryDelay )


code: void AddResponseToCache ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse )


description: Adds a join-in-progress user to the set of users associated with the currently recording replay (if any)

code: virtual void AddUserToReplay ( const [FString](API\Runtime\Core\Containers\FString) & UserString )


code: virtual void CancelStreamingRequests()


code: virtual bool CompressRequest ( FHttpRequestPtr HttpRequest, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & RequestBuffer ) const


code: void CleanupResponseCache()


code: virtual bool CompressBuffer ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InBuffer, [FHttpStreamFArchive](API\Runtime\HttpNetworkReplayStreaming\FHttpStreamFArchive) & OutCompressed ) const


code: void ConditionallyDownloadNextChunk()


code: void ConditionallyFlushStream()


code: void CancelInFlightOrPendingTask ( const [EQueuedHttpRequestType::Type](API\Runtime\HttpNetworkReplayStreaming\EQueuedHttpRequestType__Type) Type )


code: void ConditionallyRefreshViewer()


code: virtual bool DecompressBuffer ( [FHttpStreamFArchive](API\Runtime\HttpNetworkReplayStreaming\FHttpStreamFArchive) & InCompressed, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBuffer ) const


code: virtual bool DecompressResponse ( FHttpResponsePtr HttpResponse, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & ResultBuffer ) const


description: Attempts to delete the stream with the specified name. May execute asynchronously.

code: virtual void DeleteFinishedStream ( const [FString](API\Runtime\Core\Containers\FString) & StreamName, const FDeleteFinishedStreamCallback & Delegate )


code: virtual void DeleteFinishedStream ( const [FString](API\Runtime\Core\Containers\FString) & StreamName, const int32 UserIndex, const FDeleteFinishedStreamCallback & Delegate )


code: virtual void DownloadHeader ( const FDownloadHeaderCallback & Delegate )


code: void EnumerateCheckpoints()


code: virtual void EnumerateEvents ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const FEnumerateEventsCallback & Delegate )


code: virtual void EnumerateEvents ( const [FString](API\Runtime\Core\Containers\FString) & Group, const FEnumerateEventsCallback & Delegate )


code: virtual void EnumerateEvents ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const int32 UserIndex, const FEnumerateEventsCallback & Delegate )


description: Retrieves the streams that have been recently viewed. May execute asynchronously.

code: virtual void EnumerateRecentStreams ( const [FNetworkReplayVersion](API\Runtime\Core\Misc\FNetworkReplayVersion) & ReplayVersion, const int32 UserIndex, const FEnumerateStreamsCallback & Delegate )


description: Retrieves the streams that are available for viewing. May execute asynchronously. Allows the caller to pass in a custom list of query parameters

code: virtual void EnumerateStreams ( const [FNetworkReplayVersion](API\Runtime\Core\Misc\FNetworkReplayVersion) & ReplayVersion, const int32 UserIndex, const [FString](API\Runtime\Core\Containers\FString) & MetaString, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ExtraParms, const FEnumerateStreamsCallback & Delegate )


className: FHttpReplayResult

code: typedef [UE::Net::TNetResult](API\Runtime\NetCore\Net\Core\Connection\TNetResult)< EHttpReplayResult > FHttpReplayResult


code: virtual void FlushCheckpoint ( const uint32 TimeInMS )


code: void FlushCheckpointInternal ( uint32 TimeInMS )


code: void FlushStream()


description: Gets the current base directory where Demos are stored. Note, this will always fail for streamers that don't support replays stored on disk.

code: virtual EStreamingOperationResult GetDemoPath ( [FString](API\Runtime\Core\Containers\FString) & DemoPath ) const


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetHeaderArchive()


code: virtual [FString](API\Runtime\Core\Containers\FString) GetRecordingMetadata() const


description: Returns the maximum size of the friendly name text for this streamer, or 0 for unlimited.

code: virtual uint32 GetMaxFriendlyNameSize() const


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetCheckpointArchive()


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetStreamingArchive()


description: Returns the active replay name

code: virtual [FString](API\Runtime\Core\Containers\FString) GetReplayID() const


description: Return current recording/playback state

code: virtual EReplayStreamerState GetReplayStreamerState() const


code: virtual void GotoCheckpointIndex ( const int32 CheckpointIndex, const FGotoCallback & Delegate, EReplayCheckpointType CheckpointType )


description: Time in milliseconds

code: virtual uint32 GetTotalDemoTime() const


code: virtual void GotoTimeInMS ( const uint32 TimeInMS, const FGotoCallback & Delegate, EReplayCheckpointType CheckpointType )


code: void HttpAddUserFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: bool HasPendingHttpRequests() const


code: void HttpDownloadCheckpointDeltaFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpDownloadCheckpointFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpDownloadFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded, int32 RequestedStreamChunkIndex, bool bStreamWasLive )


code: void HttpDownloadHeaderFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded, FDownloadHeaderCallback Delegate )


code: void HttpEnumerateCheckpointsFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpEnumerateEventsFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded, FEnumerateEventsCallback EnumerateEventsDelegate )


code: void HttpHeaderUploadFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpEnumerateSessionsFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded, FEnumerateStreamsCallback Delegate )


code: void HttpRequestEventDataFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded, FRequestEventDataCallback RequestEventDataCompleteDelegate )


code: void HttpStartUploadingFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpStartDownloadingFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpRefreshViewerFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpUploadCheckpointFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpStopUploadingFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpUploadCustomEventFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void HttpUploadStreamFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded )


code: void InternalGotoCheckpointIndex ( const int32 CheckpointIndex, const FGotoCallback & Delegate, const FHttpRequestCompleteDelegate & RequestDelegate )


code: void InternalGotoTimeInMS ( const uint32 TimeInMS, const FGotoCallback & Delegate, bool bDelta )


code: virtual bool IsDataAvailable() const


code: bool IsHttpRequestInFlight() const


code: virtual bool IsCheckpointTypeSupported ( EReplayCheckpointType CheckpointType ) const


description: Returns true if the playing stream is currently in progress

code: virtual bool IsLive() const


code: virtual bool IsLoadingCheckpoint() const


code: bool IsStreaming() const


code: bool IsTaskPendingOrInFlight ( const [EQueuedHttpRequestType::Type](API\Runtime\HttpNetworkReplayStreaming\EQueuedHttpRequestType__Type) Type ) const


description: Used to commit a replay to permanent storage.

code: virtual void KeepReplay ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const bool bKeep, const FKeepReplayCallback & Delegate )


code: virtual bool IsDataAvailableForTimeRange ( const uint32 StartTimeInMS, const uint32 EndTimeInMS )


code: virtual void KeepReplay ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const bool bKeep, const int32 UserIndex, const FKeepReplayCallback & Delegate )


description: Purposefully passing a copy of a string here, as we call this from a delegate and don't want to inadvertently capture a reference which may go out of scope.

code: void KeepReplayFinished ( FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded, FKeepReplayCallback KeepReplayDelegate, [FString](API\Runtime\Core\Containers\FString) ReplayName )


code: virtual void ProcessRequestInternal ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > Request )


code: bool ProcessNextHttpRequest()


code: virtual void RefreshHeader()


code: void RefreshViewer ( const bool bFinal )


description: Used to change the name of a replay. Note, thiswillchange the name used to refer to the replay (if successful).

code: virtual void RenameReplay ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewName, const FRenameReplayCallback & Delegate )


code: virtual void RenameReplay ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewName, const int32 UserIndex, const FRenameReplayCallback & Delegate )


code: virtual void RenameReplayFriendlyName ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewFriendlyName, const int32 UserIndex, const FRenameReplayCallback & Delegate )


description: Used to change the friendly name of a replay. Note, changing the friendly namedoes notchange the name used to refer to replay.

code: virtual void RenameReplayFriendlyName ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewFriendlyName, const FRenameReplayCallback & Delegate )


code: virtual void RequestEventData ( const [FString](API\Runtime\Core\Containers\FString) & EventId, const FRequestEventDataCallback & Delegate )


code: virtual void RequestEventData ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & EventId, const FRequestEventDataCallback & Delegate )


code: virtual void RequestEventData ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & EventId, const int32 UserIndex, const FRequestEventDataCallback & Delegate )


code: virtual void RequestEventGroupData ( const [FString](API\Runtime\Core\Containers\FString) & Group, const FRequestEventGroupDataCallback & Delegate )


code: virtual void RequestEventGroupData ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const FRequestEventGroupDataCallback & Delegate )


code: virtual void RequestEventGroupData ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const int32 UserIndex, const FRequestEventGroupDataCallback & Delegate )


description: Delegates

code: void RequestFinished ( EReplayStreamerState ExpectedStreamerState, [EQueuedHttpRequestType::Type](API\Runtime\HttpNetworkReplayStreaming\EQueuedHttpRequestType__Type) ExpectedType, FHttpRequestPtr HttpRequest )


code: bool RetryRequest ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FQueuedHttpRequest](API\Runtime\HttpNetworkReplayStreaming\FQueuedHttpRequest) > Request, FHttpResponsePtr HttpResponse, const bool bIgnoreResponseCode )


code: virtual void SearchEvents ( const [FString](API\Runtime\Core\Containers\FString) & EventGroup, const FSearchEventsCallback & Delegate )


description: Changes the base directory where Demos are stored. Note, this will always fail for streamers that don't support replays stored on disk. This method should not be called after StartStreaming, or while async operations are pending on a streamer.

code: virtual EStreamingOperationResult SetDemoPath ( const [FString](API\Runtime\Core\Containers\FString) & DemoPath )


code: virtual void SetHighPriorityTimeRange ( const uint32 StartTimeInMS, const uint32 EndTimeInMS )


description: Deprecated* No longer used

code: void SetLastError ( const ENetworkReplayError::Type InLastError )


code: void SetLastError ( [FHttpReplayResult](API\Runtime\NetCore\Net\Core\Connection\TNetResult) && Result )


description: Sets a hint for how much data needs to be kept in memory. If set to a value greater than zero, a streamer implementation may free any in-memory data that would be required to go to a time before the beginning of the buffer.

code: virtual void SetTimeBufferHintSeconds ( const float InTimeBufferHintSeconds )


description: INetworkReplayStreamerimplementation

code: virtual void StartStreaming ( const [FStartStreamingParameters](API\Runtime\NetworkReplayStreaming\FStartStreamingParameters) & Params, const FStartStreamingCallback & Delegate )


code: virtual void StopStreaming()


code: void StopUploading()


code: virtual bool SupportsCompression() const


code: void Tick ( const float DeltaTime )


code: virtual void UpdatePlaybackTime ( uint32 TimeInMS )


code: virtual void UpdateTotalDemoTime ( uint32 TimeInMS )


description: FHttpNetworkReplayStreamer

code: void UploadHeader()


code: FHttpNetworkReplayStreamer()


description: INetworkReplayStreamingFactory


code: virtual void Flush()


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object will ever be able to tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame
true if object will ever want to be ticked, false otherwise.

code: virtual ETickableTickType GetTickableTickType() const


code: bool HasPendingHttpRequests() const


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description:
Used to determine if an object should be ticked when the game is paused. Defaults to false, as that mimics old behavior.
true if it should be ticked when paused, false otherwise

code: virtual bool IsTickableWhenPaused() const


description: FTickableGameObject

code: virtual void Tick ( float DeltaTime )


description: Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

code: virtual bool AtEnd()


className: FHttpNetworkReplayStreamingFactory

code: class FHttpNetworkReplayStreamingFactory : public [INetworkReplayStreamingFactory](API\Runtime\NetworkReplayStreaming\INetworkReplayStreamingFactory), public [FTickableGameObject](API\Runtime\Engine\FTickableGameObject)

HttpStreamers

type: TArray<TShared...


description: Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

code: virtual void Seek ( int64 InPos )


code: virtual void Serialize ( void * V, int64 Length )


className: FHttpNetworkReplayStreamer

description: Http network replay streaming manager

code: class FHttpNetworkReplayStreamer : public [INetworkReplayStreamer](API\Runtime\NetworkReplayStreaming\INetworkReplayStreamer)

bStopStreamingCalled

type: bool

CheckpointArchive

type: FHttpStreamFArc...

CheckpointList

type: FReplayEventLis...

EventGroupSet

type: TSet<FString>

GotoCheckpointDelegate

type: FGotoCallback

InFlightHttpRequest

type: TSharedPtr<FQu...

ReplayVersion

type: FNetworkReplayV...

ResponseCache

type: TMap<FString, ...

ServerURL

type: FString

StartStreamingDelegate

type: FStartStreaming...

StreamerState

type: EReplayStreamer...


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


code: virtual bool PreProcess ( [FHttpNetworkReplayStreamer](API\Runtime\HttpNetworkReplayStreaming\FHttpNetworkReplayStreamer) * Streamer, const [FString](API\Runtime\Core\Containers\FString) & ServerURL, const [FString](API\Runtime\Core\Containers\FString) & SessionName )


code: FHttpStreamFArchive()


className: FHttpStreamFArchive

description: Archive used to buffer stream over http

code: class FHttpStreamFArchive : public [FArchive](API\Runtime\Core\Serialization\FArchive)

Buffer

type: TArray< uint8 >


code: FQueuedGotoFakeCheckpoint()


code: virtual ~FQueuedGotoFakeCheckpoint()


className: FQueuedGotoFakeCheckpoint

description: FQueuedGotoFakeCheckpoint

code: class FQueuedGotoFakeCheckpoint : public [FQueuedHttpRequest](API\Runtime\HttpNetworkReplayStreaming\FQueuedHttpRequest)


code: FQueuedHttpRequest ( const [EQueuedHttpRequestType::Type](API\Runtime\HttpNetworkReplayStreaming\EQueuedHttpRequestType__Type) InType, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > InRequest )


code: virtual ~FQueuedHttpRequest()


code: FQueuedHttpRequest ( const [EQueuedHttpRequestType::Type](API\Runtime\HttpNetworkReplayStreaming\EQueuedHttpRequestType__Type) InType, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > InRequest, const int32 InMaxRetries, const float InRetryDelay )


className: FQueuedHttpRequest

code: class FQueuedHttpRequest

Request

type: TSharedPtr< cla...

RetryDelay

type: float

Type

type: EQueuedHttpRequ...


code: FQueuedHttpRequestAddEvent ( const [FString](API\Runtime\Core\Containers\FString) & InName, const uint32 InTimeInMS, const [FString](API\Runtime\Core\Containers\FString) & InGroup, const [FString](API\Runtime\Core\Containers\FString) & InMeta, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InData, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > InHttpRequest )


code: virtual ~FQueuedHttpRequestAddEvent()


className: FQueuedHttpRequestAddEvent

description: FQueuedHttpRequestAddEventCustom event so that we can defer the need to knowing SessionName until we actually send it (which we should have it by then, since requests are executed in order)

code: class FQueuedHttpRequestAddEvent : public [FQueuedHttpRequest](API\Runtime\HttpNetworkReplayStreaming\FQueuedHttpRequest)


code: FQueuedHttpRequestAddUser ( const [FString](API\Runtime\Core\Containers\FString) & InUser, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe > InHttpRequest )


className: FQueuedHttpRequestAddUser

description: FQueuedHttpRequestAddUserCustom event so that we can defer the need to knowing SessionName until we actually send it (which we should have it by then, since requests are executed in order)

code: class FQueuedHttpRequestAddUser : public [FQueuedHttpRequest](API\Runtime\HttpNetworkReplayStreaming\FQueuedHttpRequest)


code: namespace UE { namespace Net { [FNetResult](API\Runtime\NetCore\Net\Core\Connection\FNetResult) UE::Net::AddToAndConsumeChainResultPtr ( [TPimplPtr](API\Runtime\Core\Templates\TPimplPtr)< [FNetResult](API\Runtime\NetCore\Net\Core\Connection\FNetResult), EPimplPtrMode::DeepCopy > & ResultPtr, [TNetResult](API\Runtime\NetCore\Net\Core\Connection\TNetResult)< EHttpReplayResult > && Result ) } }


code: virtual ~FQueuedHttpRequestAddUser()


code: namespace UE { namespace Net { void UE::Net::AddToChainResultPtr ( [TPimplPtr](API\Runtime\Core\Templates\TPimplPtr)< [FNetResult](API\Runtime\NetCore\Net\Core\Connection\FNetResult), EPimplPtrMode::DeepCopy > & ResultPtr, [TNetResult](API\Runtime\NetCore\Net\Core\Connection\TNetResult)< EHttpReplayResult > && Result ) } }


description: Determines if the path is /

module: HttpServer

code: bool IsRoot() const


description: Gets the respective http path as a string

code: const [FString](API\Runtime\Core\Containers\FString) & GetPath() const


description: Determines if the path is valid

code: bool IsValidPath() const


description: Re-path this path sans the path of another MakeRelative(/a/b/c/d, /a/b) => /c/d

code: void MakeRelative ( const [FString](API\Runtime\Core\Containers\FString) & OtherPath )


description: TMap<> Comparer.

code: bool operator== ( const [FHttpPath](API\Runtime\HttpServer\FHttpPath) & Other ) const


description:
Parses the respective http path into a caller-supplied array
The number of tokens parsed

code: uint32 ParsePathTokens ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutPathTokens ) const


description: Constructor

code: FHttpPath()


description: Constructor

code: FHttpPath ( [FString](API\Runtime\Core\Containers\FString) InPath )


code: FHttpRouteHandleInternal ( [FString](API\Runtime\Core\Containers\FString) InPath, EHttpServerRequestVerbs InVerbs, FHttpRequestHandler InHandler )


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [FHttpServerModule](API\Runtime\HttpServer\FHttpServerModule) & Get()


description:
Per-port-binding access to an http router
AnIHttpRouterinstance that can be leveraged to respond to HTTP requests

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IHttpRouter](API\Runtime\HttpServer\IHttpRouter) > GetHttpRouter ( uint32 Port, bool bFailOnBindFailure )


description: Sets the server-relative http path

code: void SetPath ( [FString](API\Runtime\Core\Containers\FString) Path )


description:
Determines if any listeners are pending operations
true if there are pending listeners, false otherwise

code: bool HasPendingListeners() const


className: Singleton

description: Singleton Instance

code: static [FHttpServerModule](API\Runtime\HttpServer\FHttpServerModule) * Singleton = nullptr;


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: FHttpRouteHandleInternal

code: struct FHttpRouteHandleInternal

Handler

type: const FHttpRequ...

description: The respective handler to be invoked

Path

type: constFString

description: The respective bound http path

Verbs

type: const EHttpServ...

description: The qualifying http verbs for which this route is valid


description: Starts all listeners

code: void StartAllListeners()


description:
FTSTickercallback
false if no longer needs ticking, true otherwise

code: virtual bool Tick ( float DeltaTime )


description: Stops all listeners

code: void StopAllListeners()


className: FHttpServerModule

description: Module for HtttpServer Implementation

code: class FHttpServerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [FTSTickerObjectBase](API\Runtime\Core\Containers\FTSTickerObjectBase)


description: Constructor

code: FHttpServerRequest()


description:
Creates anFHttpServerResponsefrom a string
A unique pointer to an initialized response object

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FHttpServerResponse](API\Runtime\HttpServer\FHttpServerResponse) > Create ( const [FString](API\Runtime\Core\Containers\FString) & Text, [FString](API\Runtime\Core\Containers\FString) ContentType )


className: FHttpServerRequest

code: struct FHttpServerRequest

Body

description: The raw body contents

Headers

description: The HTTP headers

HttpVersion

description: The request HTTP protocol version

PathParams

description: The path parameters

PeerAddress

type: TSharedPtr<FIn...

description: The IP address of the peer that initiated the request.

QueryParams

description: The query parameters

RelativePath

type: FHttpPath

description: The handler-route-relative HTTP path

Verb

type: EHttpServerRequ...

description: The HTTP-compliant verb


description:
Creates anFHttpServerResponsefrom a raw byte buffer
A unique pointer to an initialized response object

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FHttpServerResponse](API\Runtime\HttpServer\FHttpServerResponse) > Create ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && RawBytes, [FString](API\Runtime\Core\Containers\FString) ContentType )


code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FHttpServerResponse](API\Runtime\HttpServer\FHttpServerResponse) > Create ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > & RawBytes, [FString](API\Runtime\Core\Containers\FString) ContentType )


description:
Creates anFHttpServerResponsewith the caller-supplied response and error codes
A unique pointer to an initialized response object

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FHttpServerResponse](API\Runtime\HttpServer\FHttpServerResponse) > Error ( EHttpServerResponseCodes ResponseCode, const [FString](API\Runtime\Core\Containers\FString) & ErrorCode, const [FString](API\Runtime\Core\Containers\FString) & ErrorMessage )


description:
Creates anFHttpServerResponse204
A unique pointer to an initialized response object

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FHttpServerResponse](API\Runtime\HttpServer\FHttpServerResponse) > Ok()


description: Constructor

code: FHttpServerResponse()


description: Constructor Facilitates in-place body construction

code: FHttpServerResponse ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && InBody )


className: FHttpServerResponse

code: struct FHttpServerResponse

Body

description: Http Body Content

Code

type: EHttpServerResp...

description: Http Response Code

Headers

description: Http Headers

HttpVersion

description: Http protocol version


code: namespace HttpVersion { static bool HttpVersion::FromString ( const [FString](API\Runtime\Core\Containers\FString) & HttpVersionStr, [EHttpServerHttpVersion](API\Runtime\HttpServer\HttpVersion__EHttpServerHttpVers-) & OutHttpVersion ) }


code: namespace HttpVersion { enum EHttpServerHttpVersion { HTTP_VERSION_UNKNOWN, HTTP_VERSION_1_0, HTTP_VERSION_1_1, } }


code: namespace HttpVersion { static [FString](API\Runtime\Core\Containers\FString) HttpVersion::ToString ( [EHttpServerHttpVersion](API\Runtime\HttpServer\HttpVersion__EHttpServerHttpVers-) & InHttpVersion ) }


description:
Query the router with a request.
An FHttpRouteHandle on success, nullptr otherwise.

code: bool Query ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FHttpServerRequest](API\Runtime\HttpServer\FHttpServerRequest) > & Request, const FHttpResultCallback & OnProcessingComplete )


description: Unbinds the caller-supplied Route

code: void UnbindRoute ( const FHttpRouteHandle & RouteHandle )


description:
Binds the caller-supplied Uri to the caller-supplied handler
An FHttpRouteHandle on success, nullptr otherwise.

code: FHttpRouteHandle BindRoute ( const [FHttpPath](API\Runtime\HttpServer\FHttpPath) & HttpPath, const EHttpServerRequestVerbs & HttpVerbs, const FHttpRequestHandler & Handler )


description: Unregister a request preprocessor.

code: void UnregisterRequestPreprocessor ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & RequestPreprocessorHandle )


description: Destructor

code: virtual ~IHttpRouter()


description: Register a request preprocessor. Useful for cases where you want to drop or handle incoming requests before they are dispatched to their respective handler.FDelegateHandleThe handle to the delegate, used for unregistering preprocessors.

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterRequestPreprocessor ( FHttpRequestHandler RequestPreprocessor )


className: IHttpRouter

code: class IHttpRouter : public [TSharedFromThis< IHttpRouter >](API\Runtime\Core\Templates\TSharedFromThis)


description: This is a wrapper around the above function, taking a delegate instead of a function argument.

module: Icmp

code: static void IcmpEcho ( const [FString](API\Runtime\Core\Containers\FString) & TargetAddress, float Timeout, FIcmpEchoResultDelegate ResultDelegate )


description: Multiple pings can be issued concurrently and this function will ensure they're executed in turn in order not to mix ping replies from different nodes.

code: static void IcmpEcho ( const [FString](API\Runtime\Core\Containers\FString) & TargetAddress, float Timeout, FIcmpEchoResultCallback HandleResult )


className: FIcmp

description: Simple ping interface that sends an ICMP packet to the given address and returns timing info for the reply if reachable.

code: class FIcmp


className: FIcmpEchoManyCompleteResult

code: struct FIcmpEchoManyCompleteResult

AllResults

type: TArray<FIcmpEc...

Status

type: EIcmpEchoManySt...


code: FIcmpEchoManyResult ( const [FIcmpEchoResult](API\Runtime\Icmp\FIcmpEchoResult) & InEchoResult, const [FIcmpTarget](API\Runtime\Icmp\FIcmpTarget) & InTarget )


className: FIcmpEchoManyResult

code: struct FIcmpEchoManyResult

EchoResult

type: FIcmpEchoResult

Target

type: FIcmpTarget


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [FIcmpModule](API\Runtime\Icmp\FIcmpModule) & Get()


code: static bool IsAvailable()


className: FIcmpModule

description: Logging related to parties Module for Icmp service utilities

code: class FIcmpModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


code: FIcmpTarget ( const [FString](API\Runtime\Core\Containers\FString) & InAddress, int32 InPort )


className: FIcmpEchoResult

code: struct FIcmpEchoResult

ReplyFrom

type: FString

description: Reply received from this address

ResolvedAddress

description: Addressed resolved by GetHostName

Status

type: EIcmpResponseSt...

description: Status of the final response

Time

description: Total round trip time


className: FIcmpTarget

code: struct FIcmpTarget


code: static void UDPEcho ( const [FString](API\Runtime\Core\Containers\FString) & TargetAddress, float Timeout, FIcmpEchoResultCallback HandleResult )


code: static void UDPEcho ( const [FString](API\Runtime\Core\Containers\FString) & TargetAddress, float Timeout, FIcmpEchoResultDelegate ResultDelegate )


description: The third argument is a callback function that will be invoked on the game thread after all replies are received, timed out, or otherwise terminated (e.g. remote address could not be resolved, host unreachable, send failed, etc.). It passes aFIcmpEchoManyCompleteResultinstance, containing the overall completion status, and the ping results obtained so far for all of the supplied targets.

code: static void UDPEchoMany ( const [TArray](API\Runtime\Core\Containers\TArray)< [FIcmpTarget](API\Runtime\Icmp\FIcmpTarget) > & Targets, float Timeout, FIcmpEchoManyCompleteCallback CompletionCallback )


code: static void UDPEchoMany ( const [TArray](API\Runtime\Core\Containers\TArray)< [FIcmpTarget](API\Runtime\Icmp\FIcmpTarget) > & Targets, float Timeout, FIcmpEchoManyCompleteDelegate CompletionDelegate )


description: brightness in Lumens

module: IESFile

code: float GetBrightness() const


className: FUDPPing

description: Simple ping interface that sends an ICMP packet over UDP to the given address and returns timing info for the reply if reachable.

code: class FUDPPing


description: Multiplier as the texture is normalized

code: float GetMultiplier() const


description: data to create UTextureProfile

code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetRawData() const


description: a brief description of the reason why the IES data is invalid

code: const TCHAR * GetError() const


description:
Call GetError to get a description of the error
true if the photometric data are valid

code: bool IsValid() const


description: Is loading the file, can take some time, success can be checked withIsValid()

code: FIESConverter ( const uint8 * Buffer, uint32 BufferLength )


className: FIESConverter

description: To load the IES file image format. IES files exist for many real world lights. The file stores how much light is emitted in a specific direction. The data is usually measured but tools to paint IES files exist.

code: class FIESConverter


description: RGBA -> G8 takes from theRchannel G8 -> RGBA replicated to gray

module: ImageCore

code: namespace ERawImageFormat { int64 ERawImageFormat::GetBytesPerPixel ( [Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format ) }


description: When converting from pixel bags that don't store gamma toFImageyou can use this to guess the gamma they probably wanted do not use when a real gamma flag is available!

code: namespace ERawImageFormat { EGammaSpace ERawImageFormat::GetDefaultGammaSpace ( [Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format ) }


code: namespace ERawImageFormat { const TCHAR * ERawImageFormat::GetName ( [Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format ) }


description: Get one pixel of Format type from PixelData and return in Linear color.

code: namespace ERawImageFormat { const [FLinearColor](API\Runtime\Core\Math\FLinearColor) ERawImageFormat::GetOnePixelLinear ( const void * PixelData, [Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format, EGammaSpace Gamma ) }


code: namespace ERawImageFormat { const [FLinearColor](API\Runtime\Core\Math\FLinearColor) ERawImageFormat::GetOnePixelLinear ( const void * PixelData, [Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format, bool bSRGB ) }