NetworkMetricsMutators.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/Platform.h"
#include "Containers/ArrayView.h"
#include "Misc/TVariant.h"
#include "StructUtils/InstancedStruct.h"
 
#include <limits>
 
#include "NetworkMetricsMutators.generated.h"
 
namespace UE::Net
{
    struct FNetworkMetricSnapshot;
}
 
USTRUCT()
struct FNetworkMetricsMutator
{
    GENERATED_BODY()
 
public:
    using FValueVariant = TVariant<float, int64>;
 
    virtual ~FNetworkMetricsMutator() = default;
 
    FName GetName() const;
 
    virtual void ProcessFrame(const UE::Net::FNetworkMetricSnapshot& Snapshot) PURE_VIRTUAL(FNetworkMetricsMutator::ProcessFrame, );
 
    virtual void Reset() PURE_VIRTUAL(FNetworkMetricsMutator::Reset, );
 
    virtual FValueVariant GetValue() const PURE_VIRTUAL(FNetworkMetricsMutator::GetValue, return FValueVariant(TInPlaceType<float>(), 0.0f););
 
    virtual TArrayView<const FName> GetAllMetricNames() const PURE_VIRTUAL(FNetworkMetricsMutator::GetAllMetricNames, return TArrayView<const FName>(););
 
private:
    virtual FName GetNameInternal() const PURE_VIRTUAL(FNetworkMetricsMutator::GetNameInternal, return FName(););
 
    UPROPERTY(Config)
    FName NameOverride;
};
 
template<>
struct TStructOpsTypeTraits<FNetworkMetricsMutator> : public TStructOpsTypeTraitsBase2<FNetworkMetricsMutator>
{
    enum
    {
        WithPureVirtual = true
    };
};
 
USTRUCT()
struct FNetworkMetricsMutatorAvg : public FNetworkMetricsMutator
{
    GENERATED_BODY()
 
public:
    virtual void ProcessFrame(const UE::Net::FNetworkMetricSnapshot& Snapshot) override;
    virtual void Reset() override;
    virtual FValueVariant GetValue() const override;
 
    virtual TArrayView<const FName> GetAllMetricNames() const override
    {
        return MakeConstArrayView(&MetricName, 1);
    }
 
private:
    virtual FName GetNameInternal() const override;
 
    void AddIntSample(int64 Sample);
    void AddFloatSample(float Sample);
 
    int64 IntTotal = 0;
    float FloatTotal = 0.0f;
    uint32 NumSamples = 0;
 
    UPROPERTY(Config)
    FName MetricName;
 
    mutable FName MutatorName;
};
 
USTRUCT()
struct FNetworkMetricsMutatorMin : public FNetworkMetricsMutator
{
    GENERATED_BODY()
 
public:
    virtual void ProcessFrame(const UE::Net::FNetworkMetricSnapshot& Snapshot) override;
    virtual void Reset() override;
    virtual FValueVariant GetValue() const override;
 
    virtual TArrayView<const FName> GetAllMetricNames() const override
    {
        return MakeConstArrayView(&MetricName, 1);
    }
 
private:
    virtual FName GetNameInternal() const override;
 
    FValueVariant MinValue = FValueVariant(TInPlaceType<int64>(), std::numeric_limits<int64>::max());
 
    UPROPERTY(Config)
    FName MetricName;
 
    mutable FName MutatorName;
};
 
USTRUCT()
struct FNetworkMetricsMutatorMax : public FNetworkMetricsMutator
{
    GENERATED_BODY()
 
public:
    virtual void ProcessFrame(const UE::Net::FNetworkMetricSnapshot& Snapshot) override;
    virtual void Reset() override;
    virtual FValueVariant GetValue() const override;
 
    virtual TArrayView<const FName> GetAllMetricNames() const override
    {
        return MakeConstArrayView(&MetricName, 1);
    }
 
private:
    virtual FName GetNameInternal() const override;
 
    FValueVariant MaxValue = FValueVariant(TInPlaceType<int64>(), std::numeric_limits<int64>::lowest());
 
    UPROPERTY(Config)
    FName MetricName;
 
    mutable FName MutatorName;
};
 
USTRUCT()
struct FNetworkMetricsMutatorPercent : public FNetworkMetricsMutator
{
    GENERATED_BODY()
 
public:
    virtual void ProcessFrame(const UE::Net::FNetworkMetricSnapshot& Snapshot) override;
    virtual void Reset() override;
 
    virtual FValueVariant GetValue() const override;
 
    virtual TArrayView<const FName> GetAllMetricNames() const override;
 
protected:
    void SetNumeratorMetricName(FName MetricName)
    {
        NumeratorName = MetricName;
    }
 
    void SetDenominatorMetricName(FName MetricName)
    {
        DenominatorName = MetricName;
    }
 
private:
    virtual FName GetNameInternal() const override;
 
    // Private template so it can be defined in the .cpp file.
    template<class T>
    static void UpdateFromSnapshotValue(FNetworkMetricsMutator::FValueVariant& InOutValue, T MetricValue);
 
    // Source metric names stored in an array so we can return a view to it from GetAllMetricNames.
    mutable TArray<FName, TInlineAllocator<2>> SourceMetricNames;
 
    FValueVariant Numerator = FValueVariant(TInPlaceType<int64>(), 0);
    FValueVariant Denominator = FValueVariant(TInPlaceType<int64>(), 0);
 
    UPROPERTY(Config)
    FName NumeratorName;
 
    UPROPERTY(Config)
    FName DenominatorName;
 
    // Auto-generated mutator name, derived from source metrics.
    mutable FName MutatorName;
};
 
USTRUCT()
struct FNetworkMetricsMutatorOutPacketLoss : public FNetworkMetricsMutatorPercent
{
    GENERATED_BODY()
 
public:
    FNetworkMetricsMutatorOutPacketLoss();
 
private:
    virtual FName GetNameInternal() const override
    {
        return FName("OutPacketLoss");
    }
};
 
USTRUCT()
struct FNetworkMetricsMutatorInPacketLoss : public FNetworkMetricsMutatorPercent
{
    GENERATED_BODY()
 
public:
    FNetworkMetricsMutatorInPacketLoss();
 
private:
    virtual FName GetNameInternal() const override
    {
        return FName("InPacketLoss");
    }
};