C++ API Library Reference  4.3.2-74-ge1d4cca
Public Functions | List of all members
ProfilerManager Class Reference

The ProfilerManager class aggregates information from all profilers and stores it in application state. See IProfiler for information on how create profilers, and SimpleValue for an example of a profiler.

Public Functions

bool IsUpdating ()
 
void RegisterProfiler (CSI::String path, IProfiler *)
 
void SetIsUpdating (bool isUpdating)
 
void SetUpdateIntervalMs (int ms)
 
void StartUpdating ()
 
void StopUpdating ()
 
void UnregisterProfiler (CSI::String path)
 
int UpdateIntervalMs ()
 

Usage Description

bool IsUpdating ( )

Returns a Boolean value indicating whether the ProfilerManager is currently updating profiler information in application state.

void RegisterProfiler ( CSI::String  path,
IProfiler profiler 
)

Registers an implementation of IProfiler with this ProfilerManager.

Parameters
pathThe local path of the profiler information in application state.
IProfilerThe profiler that generates that information.
void SetIsUpdating ( bool  isUpdating)

Sets this value to true if ProfilerManager is currently updating profiler information application state.

void SetUpdateIntervalMs ( int  ms)

Sets the update interval; this is the time interval (in milliseconds) between successive updates of the profiler information to application state.

void StartUpdating ( )

Triggers the ProfilerManager to start aggregating profiler information to application state.

void StopUpdating ( )

Triggers the ProfilerManager to stop aggregating profiler information to application state.

void UnregisterProfiler ( CSI::String  path)

Releases the connection to the ProfilerManager so that it no longer stores this profiler's information.

Parameters
pathThe local path of the profiler information in application state.
int UpdateIntervalMs ( )

Returns the update interval; this is the time interval (in milliseconds) between successive updates of the profiler information to application state.