FNetworkMetricsMutator Struct Reference

#include <NetworkMetricsMutators.h>

Inheritance diagram for FNetworkMetricsMutator:

Public Types
using	FValueVariant = TVariant< float, int64 >

Public Member Functions
virtual	~FNetworkMetricsMutator ()=default
FName	GetName () const

Public Attributes
virtual void virtual ProcessFrame(const UE::Net::FNetworkMetricSnapshot &Snapshot) PURE_VIRTUAL(FNetworkMetricsMutator void virtual Reset() PURE_VIRTUAL(FNetworkMetricsMutator FValueVariant	GetValue () const PURE_VIRTUAL(FNetworkMetricsMutator
virtual TArrayView< const FName >	GetAllMetricNames () const PURE_VIRTUAL(FNetworkMetricsMutator

Detailed Description

A metrics mutator is a component of a UNetworkMetricsBaseListener that receices a metrics snapshot every frame. This enables a mutator to accumulate and/or transform (possibly multiple) input metrics into a single output value over the reporting interval of its owning listener. For example, FNetworkMetricsMutatorAvg allows a listener to report the average of a metric over a whole reporting interval.

Member Typedef Documentation

FValueVariant

using FNetworkMetricsMutator::FValueVariant = TVariant<float, int64>

Constructor & Destructor Documentation

~FNetworkMetricsMutator()

virtual FNetworkMetricsMutator::~FNetworkMetricsMutator ( )

virtualdefault

Member Function Documentation

GetName()

FName FNetworkMetricsMutator::GetName

(

)

const

Returns the name of this mutator. Independent of metric names in the database. Either NameOverride if set, otherwise returns GetNameInternal().

Member Data Documentation

GetAllMetricNames

virtual TArrayView<const FName> FNetworkMetricsMutator::GetAllMetricNames() const PURE_VIRTUAL(FNetworkMetricsMutator

Returns a list of all metrics used by this mutator.

GetValue

virtual void virtual ProcessFrame (const UE::Net::FNetworkMetricSnapshot& Snapshot) PURE_VIRTUAL(FNetworkMetricsMutator void virtual Reset () PURE_VIRTUAL(FNetworkMetricsMutator FValueVariant FNetworkMetricsMutator::GetValue() const PURE_VIRTUAL(FNetworkMetricsMutator

Called every frame with a snapshot containing this mutator's metrics. Clears internal data, typically used after a listener reports its metrics. Returns this mutator's current computed value

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Public/Net/NetworkMetricsMutators.h
• Engine/Source/Runtime/Engine/Private/Net/NetworkMetricsMutators.cpp