FBandwidthMeasurementTool

API > API/Runtime > API/Runtime/BandwidthMeasurementTool

   
Name FBandwidthMeasurementTool
Type class
Header File /Engine/Source/Runtime/Online/Experimental/BandwidthMeasurementTool/Public/BandwidthMeasurementTool.h
Include Path #include "BandwidthMeasurementTool.h"

Syntax

class FBandwidthMeasurementTool

Constructors

Name Remarks Include Path Unreal Specifiers
  BandwidthMeasurementTool.h  
  BandwidthMeasurementTool.h  
Member Functions. BandwidthMeasurementTool.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FBandwidthMeasurementTool()

   BandwidthMeasurementTool.h  

Structs

Name Remarks
FBandwidthSnapshotData Telemetry Data
FMeasurementQualityStats Measurement quality stats.

Constants

Name Type Remarks Include Path
Instance TUniquePtr< FBandwidthMeasurementTool > Singleton instance pointer. BandwidthMeasurementTool.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveRequests TArray< TSharedRef< IHttpRequest > > Fixed array of TSharedRef to track request states. BandwidthMeasurementTool.h  
bHasTheLastRequestFinishedEarly bool Used to tell if the final request finished before hitting the maximum run time. BandwidthMeasurementTool.h  
bReadyToMeasureAfterWarmupPeriod bool State Tracking used to allow for communication line warmup. BandwidthMeasurementTool.h  
CurrentBandwidthMeasurementInBps uint64 Current average throughput. BandwidthMeasurementTool.h  
EnableChangedDelegate FDelegateHandle Tracker for Enable state changes. BandwidthMeasurementTool.h  
MeasurementStartTimestamp double Wall-clock timestamp (FPlatformTime::Seconds) when post-warmup measurement began. BandwidthMeasurementTool.h  
MeasurementTimer FTSTicker::FDelegateHandle Tick handle needed to track current measurements time passage. BandwidthMeasurementTool.h  
Mutex FTransactionallySafeCriticalSection Mutex to keep data consistent across multiple potential thread executions. BandwidthMeasurementTool.h  
OnBandwidthMeasurementComplete UE::BandwidthMeasurement::FOnMeasurementComplete External reporting callback. BandwidthMeasurementTool.h  
RequestMemoryThroughputHistory TArray< uint64 > Queue of fixed size for history average. BandwidthMeasurementTool.h  
TelemetryData FBandwidthSnapshotData Storage structure for telemetry reporting. BandwidthMeasurementTool.h  
TotalBytesReceived std::atomic< uint64 > The total number of bytes received via http requests this measurement. BandwidthMeasurementTool.h  
WarmupTimer FTSTicker::FDelegateHandle Tick handle to track time for the "warm up" period. BandwidthMeasurementTool.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BeginMeasurement()

 Trigger measurement. BandwidthMeasurementTool.h  

void ClearHistory()

 Exposed Utility Functions BandwidthMeasurementTool.h  

TOptional< FMeasurementQualityStats > ComputeMeasurementQuality()

 Computes quality stats from recent measurement history. Returns empty if insufficient data. BandwidthMeasurementTool.h  

const FBandwidthSnapshotData & GetTelemetryData()

 Returns Telemetry Data for reporting. BandwidthMeasurementTool.h  

float GetTimeNeededForMeasurement()

 Get delay time needed for measurement. BandwidthMeasurementTool.h  

void Initialize()

 Lifecycle (called by module) BandwidthMeasurementTool.h  

bool IsBandwidthBeingMeasured()

 Report out measurement completion. BandwidthMeasurementTool.h  

void Log ( bool bPrint
)

   BandwidthMeasurementTool.h  

void RegisterForCompletedMeasurement ( TFunction< void(uint64)>&& FunctionPtr
)

 Assign to call back function to report when measurement is complete. BandwidthMeasurementTool.h  

void Shutdown()

   BandwidthMeasurementTool.h  

Static

Name Remarks Include Path Unreal Specifiers
Singleton access BandwidthMeasurementTool.h  

Operators

Name Remarks Include Path Unreal Specifiers
  BandwidthMeasurementTool.h  
  BandwidthMeasurementTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page