FPerfCountersModule Class Reference

Inheritance diagram for FPerfCountersModule:

Public Member Functions
	FPerfCountersModule ()
virtual void	ShutdownModule () override
virtual bool	SupportsDynamicReloading () override
virtual bool	SupportsAutomaticShutdown () override
IPerfCounters *	GetPerformanceCounters () const
IPerfCounters *	CreatePerformanceCounters (const FString &UniqueInstanceId) override
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	StartupModule ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual bool	IsGameModule () const

Additional Inherited Members
Static Public Member Functions inherited from IPerfCountersModule
static IPerfCountersModule &	Get ()
static bool	IsAvailable ()
static PERFCOUNTERS_API int32	GetHTTPStatsPort ()

Constructor & Destructor Documentation

FPerfCountersModule()

FPerfCountersModule::FPerfCountersModule ( )

inline

Member Function Documentation

CreatePerformanceCounters()

IPerfCounters * FPerfCountersModule::CreatePerformanceCounters ( const FString &  UniqueInstanceId )

inlineoverridevirtual

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

Implements IPerfCountersModule.

GetPerformanceCounters()

IPerfCounters * FPerfCountersModule::GetPerformanceCounters ( ) const

inlinevirtual

Returns

the currently initialized / in use perf counters

Implements IPerfCountersModule.

ShutdownModule()

virtual void FPerfCountersModule::ShutdownModule ( )

inlineoverridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

SupportsAutomaticShutdown()

virtual bool FPerfCountersModule::SupportsAutomaticShutdown ( )

inlineoverridevirtual

Override this to set whether your module would like cleanup on application shutdown

Returns

Whether the module supports shutdown on application exit

Reimplemented from IModuleInterface.

SupportsDynamicReloading()

virtual bool FPerfCountersModule::SupportsDynamicReloading ( )

inlineoverridevirtual

Override this to set whether your module is allowed to be unloaded on the fly

Returns

Whether the module supports shutdown separate from the rest of the engine.

Reimplemented from IModuleInterface.

---

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

• Engine/Source/Runtime/PerfCounters/Private/PerfCountersModule.cpp