UNetworkMetricsCSV Class Reference

A metrics listener that reports an array of metrics to CSV. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UNetworkMetricsBaseListener
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Additional Inherited Members
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Detailed Description

A metrics listener that reports an array of metrics to CSV.

The function SetCategory() is expected to be called before the listener is registered with FNetworkMetricsDatabase::Register(). This function will associate the instance of UNetworkMetricsCSV with a category of values in CSV.

To use UNetworkMetricsCSV in a configuration file, a sub-class of UNetworkMetricsCSV must be created that calls SetCategory() from the constructor to provide the CSV category to use.

UCLASS() class UNetworkMetricsCSV_ExampleCategory : public UNetworkMetricsCSV { GENERATED_BODY() public: virtual ~UNetworkMetricsCSV_ExampleCategory() = default;

UNetworkMetricsCSV_ExampleCategory() : UNetworkMetricsCSV() { SetCategory("ExampleCategory"); } };

This sub-class can then be used in the configuration file when registering a listener:

[/Script/Engine.NetworkMetricsConfig]
+Listeners=(MetricName=ExampleMetric, ClassName=/Script/Engine.NetworkMetricsCSV_ExampleCategory)

If the base UNetworkMetricsCSV class is used in the configuration file, CSV stats will be recorded to the default 'Networking' category.

Member Function Documentation

StaticClass()

UClass StaticClass ( )

static