1. Epic GamesDeveloper
  3. FHttpNetworkReplayStreamer

FHttpNetworkReplayStreamer

Http network replay streaming manager

API > API/Runtime > API/Runtime/HttpNetworkReplayStreaming

Inheritance Hierarchy

References

   
Module HttpNetworkReplayStreaming
Header /Engine/Source/Runtime/NetworkReplayStreaming/HttpNetworkReplayStreaming/Public/HttpNetworkReplayStreaming.h
Include #include "HttpNetworkReplayStreaming.h"

Syntax

class FHttpNetworkReplayStreamer : public INetworkReplayStreamer

Remarks

Http network replay streaming manager

Variables

  Type Name Description
Public variable bool bStopStreamingCalled  
Public variable bool bStreamIsLive  
Public variable FHttpStreamFArchive CheckpointArchive  
Public variable FReplayEventList CheckpointList  
Public variable int32 DeltaDownloadCheckpointIndex  
Public variable int32 DownloadCheckpointIndex  
Public variable TSet< FString > EventGroupSet  
Public variable FGotoCallback GotoCheckpointDelegate  
Public variable FHttpStreamFArchive HeaderArchive  
Public variable uint32 HighPriorityEndTime  
Public variable TSharedPtr< FQueuedHttpRequest > InFlightHttpRequest  
Public variable double LastChunkTime  
Public variable int64 LastGotoTimeInMS  
Public variable double LastRefreshCheckpointTime  
Public variable double LastRefreshViewerTime  
Public variable uint32 LastTotalDemoTimeInMS  
Public variable int32 NumTotalStreamChunks  
Public variable TArray< TSharedPtr< FQueuedHttpRequest > > QueuedHttpRequests  
Public variable int32 RefreshViewerFails  
Public variable FNetworkReplayVersion ReplayVersion  
Public variable TMap< FString, FCachedResponse > ResponseCache  
Public variable FString ServerURL  
Public variable FString SessionName  
Public variable FStartStreamingCallback StartStreamingDelegate  
Public variable FHttpStreamFArchive StreamArchive  
Public variable int32 StreamChunkIndex  
Public variable EReplayStreamerState StreamerState  
Public variable FString StreamMetadata  
Public variable uint32 StreamTimeRangeEnd  
Public variable uint32 StreamTimeRangeStart  
Public variable uint32 TotalDemoTimeInMS  
Public variable uint64 TotalUploadBytes  
Public variable FString ViewerName  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function void

AddRequestToQueue ( const EQueuedHttpRequestType::Type Type,
TSharedPtr< class IHttpRequest, ESPMode::ThreadSafe > Request,
const int32 InMaxRetries,
const float InRetryDelay
)

  
Public function void

AddResponseToCache ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse
)

  
Public function void  
Public function Virtual void  
Public function void  
Public function Virtual Const bool

CompressBuffer ( const TArray< uint8 >& InBuffer,
FHttpStreamFArchive& OutCompressed
)

  
Public function Virtual Const bool

CompressRequest ( FHttpRequestPtr HttpRequest,
const TArray< uint8 >& RequestBuffer
)

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function Virtual Const bool

DecompressBuffer ( FHttpStreamFArchive& InCompressed,
TArray< uint8 >& OutBuffer
)

  
Public function Virtual Const bool

DecompressResponse ( FHttpResponsePtr HttpResponse,
TArray< uint8 >& ResultBuffer
)

  
Public function void  
Public function void

FlushCheckpointInternal ( uint32 TimeInMS
)

  
Public function void  
Public function Virtual Const FString  
Public function Const bool  
Public function void

HttpAddUserFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

HttpDownloadCheckpointDeltaFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

HttpDownloadCheckpointFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

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

  
Public function void

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

  
Public function void

HttpEnumerateCheckpointsFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

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

  
Public function void

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

  
Public function void

HttpHeaderUploadFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

HttpRefreshViewerFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

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

  
Public function void

HttpStartDownloadingFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

HttpStartUploadingFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

HttpStopUploadingFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

HttpUploadCheckpointFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

HttpUploadCustomEventFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

HttpUploadStreamFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded
)

  
Public function void

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

  
Public function void

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

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void

KeepReplayFinished ( FHttpRequestPtr HttpRequest,
FHttpResponsePtr HttpResponse,
bool bSucceeded,
FKeepReplayCallback KeepReplayDelegate,
FString ReplayName
)

 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.
Public function bool  
Public function Virtual void

ProcessRequestInternal ( TSharedPtr< class IHttpRequest, ESPMode::ThreadSafe > Request
)

  
Public function void

RefreshViewer ( const bool bFinal
)

  
Public function void

RequestFinished ( EReplayStreamerState ExpectedStreamerState,
EQueuedHttpRequestType::Type ExpectedType,
FHttpRequestPtr HttpRequest
)

 Delegates
Public function bool

RetryRequest ( TSharedPtr< FQueuedHttpRequest > Request,
FHttpResponsePtr HttpResponse,
const bool bIgnoreResponseCode
)

  
Public function void  
Public function void  
Public function Virtual Const bool  
Public function void

Tick ( const float DeltaTime
)

  
Public function void FHttpNetworkReplayStreamer

Overridden from INetworkReplayStreamer

  Type Name Description
Public function Virtual void

AddEvent ( const uint32 TimeInMS,
const FString& Group,
const FString& Meta,
const TArray< uint8 >& Data
)

  
Public function Virtual void

AddOrUpdateEvent ( const FString& Name,
const uint32 TimeInMS,
const FString& Group,
const FString& Meta,
const TArray< uint8 >& Data
)

  
Public function Virtual void

AddUserToReplay ( const FString& UserString
)

 Adds a join-in-progress user to the set of users associated with the currently recording replay (if any)
Public function Virtual void

DeleteFinishedStream ( const FString& StreamName,
const int32 UserIndex,
const FDeleteFinishedStreamCallback& Delegate
)

  
Public function Virtual void

DeleteFinishedStream ( const FString& StreamName,
const FDeleteFinishedStreamCallback& Delegate
)

 Attempts to delete the stream with the specified name. May execute asynchronously.
Public function Virtual void

DownloadHeader ( const FDownloadHeaderCallback& Delegate
)

  
Public function Virtual void

EnumerateEvents ( const FString& Group,
const FEnumerateEventsCallback& Delegate
)

  
Public function Virtual void

EnumerateEvents ( const FString& ReplayName,
const FString& Group,
const FEnumerateEventsCallback& Delegate
)

  
Public function Virtual void

EnumerateEvents ( const FString& ReplayName,
const FString& Group,
const int32 UserIndex,
const FEnumerateEventsCallback& Delegate
)

  
Public function Virtual void

EnumerateRecentStreams ( const FNetworkReplayVersion& ReplayVersion,
const int32 UserIndex,
const FEnumerateStreamsCallback& Delegate
)

 Retrieves the streams that have been recently viewed. May execute asynchronously.
Public function Virtual void

EnumerateStreams ( const FNetworkReplayVersion& ReplayVersion,
const int32 UserIndex,
const FString& MetaString,
const TArray< FString >& ExtraParms,
const FEnumerateStreamsCallback& Delegate
)

 Retrieves the streams that are available for viewing.
Public function Virtual void

FlushCheckpoint ( const uint32 TimeInMS
)

  
Public function Virtual FArchive *  
Public function Virtual Const EStreamingOperationResult

GetDemoPath ( FString& DemoPath
)

 Gets the current base directory where Demos are stored.
Public function Virtual FArchive *  
Public function Virtual Const uint32 Returns the maximum size of the friendly name text for this streamer, or 0 for unlimited.
Public function Virtual Const FString Returns the active replay name
Public function Virtual Const EReplayStreamerState Return current recording/playback state
Public function Virtual FArchive *  
Public function Virtual Const uint32 Time in milliseconds
Public function Virtual void

GotoCheckpointIndex ( const int32 CheckpointIndex,
const FGotoCallback& Delegate,
EReplayCheckpointType CheckpointType
)

  
Public function Virtual void

GotoTimeInMS ( const uint32 TimeInMS,
const FGotoCallback& Delegate,
EReplayCheckpointType CheckpointType
)

  
Public function Virtual Const bool

IsCheckpointTypeSupported ( EReplayCheckpointType CheckpointType
)

  
Public function Virtual Const bool  
Public function Virtual bool

IsDataAvailableForTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

  
Public function Virtual Const bool

IsLive ()

 Returns true if the playing stream is currently in progress
Public function Virtual Const bool  
Public function Virtual void

KeepReplay ( const FString& ReplayName,
const bool bKeep,
const FKeepReplayCallback& Delegate
)

 Used to commit a replay to permanent storage.
Public function Virtual void

KeepReplay ( const FString& ReplayName,
const bool bKeep,
const int32 UserIndex,
const FKeepReplayCallback& Delegate
)

  
Public function Virtual void  
Public function Virtual void

RenameReplay ( const FString& ReplayName,
const FString& NewName,
const int32 UserIndex,
const FRenameReplayCallback& Delegate
)

  
Public function Virtual void

RenameReplay ( const FString& ReplayName,
const FString& NewName,
const FRenameReplayCallback& Delegate
)

 Used to change the name of a replay.
Public function Virtual void

RenameReplayFriendlyName ( const FString& ReplayName,
const FString& NewFriendlyName,
const int32 UserIndex,
const FRenameReplayCallback& Delegate
)

  
Public function Virtual void

RenameReplayFriendlyName ( const FString& ReplayName,
const FString& NewFriendlyName,
const FRenameReplayCallback& Delegate
)

 Used to change the friendly name of a replay.
Public function Virtual void

RequestEventData ( const FString& ReplayName,
const FString& EventId,
const FRequestEventDataCallback& Delegate
)

  
Public function Virtual void

RequestEventData ( const FString& EventId,
const FRequestEventDataCallback& Delegate
)

  
Public function Virtual void

RequestEventData ( const FString& ReplayName,
const FString& EventId,
const int32 UserIndex,
const FRequestEventDataCallback& Delegate
)

  
Public function Virtual void

RequestEventGroupData ( const FString& Group,
const FRequestEventGroupDataCallback& Delegate
)

  
Public function Virtual void

RequestEventGroupData ( const FString& ReplayName,
const FString& Group,
const FRequestEventGroupDataCallback& Delegate
)

  
Public function Virtual void

RequestEventGroupData ( const FString& ReplayName,
const FString& Group,
const int32 UserIndex,
const FRequestEventGroupDataCallback& Delegate
)

  
Public function Virtual void

SearchEvents ( const FString& EventGroup,
const FSearchEventsCallback& Delegate
)

  
Public function Virtual EStreamingOperationResult

SetDemoPath ( const FString& DemoPath
)

 Changes the base directory where Demos are stored.
Public function Virtual void

SetHighPriorityTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

  
Public function Virtual void

SetTimeBufferHintSeconds ( const float InTimeBufferHintSeconds
)

 Sets a hint for how much data needs to be kept in memory.
Public function Virtual void

StartStreaming ( const FStartStreamingParameters& Params,
const FStartStreamingCallback& Delegate
)

 INetworkReplayStreamer implementation
Public function Virtual void  
Public function Virtual void

UpdatePlaybackTime ( uint32 TimeInMS
)

  
Public function Virtual void

UpdateTotalDemoTime ( uint32 TimeInMS
)

  

Typedefs

Name Description
FHttpReplayResult  

Deprecated Functions

  Type Name Description
Public function void

SetLastError ( const ENetworkReplayError::Type InLastError
)

 No longer used

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page