pureweb.client.diagnostics. ProfilerManager

Manages aggregating profiler information and storing it in application state.

Method Summary

getFramework
Returns the Framework instance that stores the profiler information.
getProfilerInfoPath
Returns the path to the profiling information in the application state tree.
getUpdateIntervalMs
Returns the update interval, in milliseconds.
registerProfiler
Registers an implementation of Profiler with this ProfilerManager.
setFramework
Sets the Framework instance that stores the profiler information.
setUpdateIntervalMs
Sets the update interval.
startUpdating
Triggers the ProfilerManager to start aggregating profiler information to application state.
stopUpdating
Triggers the ProfilerManager to stop aggregating profiler information to application state.
unregisterProfiler
Releases the connection to the ProfilerManager so that it no longer stores this profiler's information.

Constructor

new ProfilerManager(updateIntervalMs, framework)

Initializes a new instance of ProfilerManager.
Parameters:
Name Type Argument Description
updateIntervalMs number <optional>
The update interval, in milliseconds; if not specified, defaults to 1000 ms.
framework pureweb.client.Framework <optional>
The Framework instance; if not specified, defaults to null, in which case a later call to setFramework must be made to set the framework.

Members

lastUpdatedpureweb.client.diagnostics.SimpleValueProfiler

A profiler that stores the local time of the last known update.

profilingpureweb.client.diagnostics.EventProfiler

A profiler that stores the local time of the last known update.

Method Detail

getFramework() → {pureweb.client.Framework}

Returns the Framework instance that stores the profiler information.

getProfilerInfoPath() → {string}

Returns the path to the profiling information in the application state tree.

getUpdateIntervalMs() → {number}

Returns the update interval, in milliseconds. This is the time interval between successive updates of the profiler information to application state.

registerProfiler(path, profiler)

Registers an implementation of Profiler with this ProfilerManager.
Parameters:
Name Type Description
path string The local path of the profiler information.
profiler pureweb.client.diagnostics.Profiler The profiler that contains that information.

setFramework(framework)

Sets the Framework instance that stores the profiler information.
Parameters:
Name Type Description
framework pureweb.client.Framework The framework to set.

setUpdateIntervalMs(updateIntervalMs)

Sets the update interval. This is the time interval between successive updates of the profiler information to application state.
Parameters:
Name Type Description
updateIntervalMs number The update interval, in milliseconds.

startUpdating()

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

stopUpdating()

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

unregisterProfiler(path)

Releases the connection to the ProfilerManager so that it no longer stores this profiler's information.
Parameters:
Name Type Description
path string The local path of the profiler information.