#include <PerfCountersModule.h>

Inheritance diagram for IPerfCountersModule:

Public Member Functions
virtual IPerfCounters *	GetPerformanceCounters () const =0

virtual IPerfCounters *	CreatePerformanceCounters (const FString &UniqueInstanceId=TEXT(""))=0

Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()

virtual void	StartupModule ()

virtual void	PreUnloadCallback ()

virtual void	PostLoadCallback ()

virtual void	ShutdownModule ()

virtual bool	SupportsDynamicReloading ()

virtual bool	SupportsAutomaticShutdown ()

virtual bool	IsGameModule () const

Static Public Member Functions
static IPerfCountersModule &	Get ()

static bool	IsAvailable ()

static PERFCOUNTERS_API int32	GetHTTPStatsPort ()

Detailed Description

The public interface to this module

Member Function Documentation

◆ CreatePerformanceCounters()

virtual IPerfCounters * IPerfCountersModule::CreatePerformanceCounters ( const FString & UniqueInstanceId = TEXT("") )

pure virtual

Creates and initializes the performance counters object

Parameters

UniqueInstanceId optional parameter that allows to assign a known name for this set of counters (a default one that will include process id will be provided if not given)

Returns: IPerfCounters object (should be explicitly deleted later), or nullptr if failed

Implemented in FPerfCountersModule.

◆ Get()

static IPerfCountersModule & IPerfCountersModule::Get ( )

inlinestatic

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns: Returns singleton instance, loading the module on demand if needed

◆ GetHTTPStatsPort()

int32 IPerfCountersModule::GetHTTPStatsPort ( )

static

Returns the HTTP port to bind for the stats request. Returns -1 if none were specified

◆ GetPerformanceCounters()

virtual IPerfCounters * IPerfCountersModule::GetPerformanceCounters ( ) const

pure virtual

Returns: the currently initialized / in use perf counters

Implemented in FPerfCountersModule.

◆ IsAvailable()

static bool IPerfCountersModule::IsAvailable ( )

inlinestatic

Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.

Returns: True if the module is loaded and ready to use

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

Engine/Source/Runtime/PerfCounters/Public/PerfCountersModule.h
Engine/Source/Runtime/PerfCounters/Private/PerfCountersModule.cpp

Public Member Functions