Session¶
Namespace: WellFired
Implements: WellFired.Profile.ISession
Description¶
Our basic profiler object
Public Methods¶
Session ( ) | |
Session ( ITimer timer, IRuntimeTaskLooper runtimeTaskLooper ) | |
void | Track ( IProbe probe, RecordMode recordMode = RecordMode.Continous, int interval = 0 ) |
void | Track ( Func< object > method, RecordMode recordMode = RecordMode.Continous, int interval = 0 ) |
void | Track ( IEnumerable< DefaultProbe > probes ) |
void | ProcessData ( IProfileProcessor processor ) |
void | StartRecording ( ) |
void | StopRecording ( ) |
Breakdown¶
Session ( )
Description
Creates a new instance of Profile, with default settings, you’ll likely only need to call this
Session ( ITimer timer, IRuntimeTaskLooper runtimeTaskLooper )
Description
Creates a new instance of Profile allowing you to provide a custom timer and task looper
Parameters
timer runtimeTaskLooper
void Track ( IProbe probe, RecordMode recordMode = RecordMode.Continous, int interval = 0 )
Description
Tracks a given probe, with the passed data
Parameters
probe The probe that we should track recordMode The record mode to use when we’re getting tracked data interval The interval that we would like to use when retrieving tracked data
void Track ( Func< object > method, RecordMode recordMode = RecordMode.Continous, int interval = 0 )
Description
Allows you to track custom data on this profiler, simply pass the method that will extract the custom data as the first parameter
Parameters
method A delegate that will be used to extract custom data recordMode The record mode to use when we’re getting tracked data interval The interval that we would like to use when retrieving tracked data
void Track ( IEnumerable< DefaultProbe > probes )
Description
Tracks a collection of probes.
Parameters
probes
void ProcessData ( IProfileProcessor processor )
Description
How do you want to process the data. We provide many default processors including the VisualProcessor, which will display data to the screen
Parameters
processor
void StartRecording ( )
Description
Start Recording Data
void StopRecording ( )
Description
Stop recording data