|
FireSync API
|
Represents a code profiling probe.
Profiling probes are associated with a health collection provider. A default health collection provider may be installed by the application environment. If not, or if a more specific collection provider is desired, the kProfileProbe_ConstructEx constructor can be used to construct a probe and attach it to the specified provider.
Code profiling probes are intended to efficiently measure the elapsed time of relatively brief operations. As such, profiling timers may overflow and produce incorrect results if used to measure operations that require longer than a few seconds. If a long duration needs to be meausred, consider using kTimer and kHealthProbe instead of kProfileProbe.
Code profiling is effectively disabled unless the K_PROFILE prepocessor flag is defined.
Public Member Functions | |
| kStatus | kProfileProbe_Construct (kProfileProbe *probe, const kChar *name, kAlloc allocator) |
| Constructs a kProfileProbe object attached to the default health provider. More... | |
| kStatus | kProfileProbe_ConstructEx (kProfileProbe *probe, kHealth provider, const kChar *name, kAlloc allocator) |
| Constructs a kProfileProbe object attached to the specified health provider. More... | |
| void | kProfileProbe_Start (kProfileProbe probe) |
| Begins a code profiling measurement. More... | |
| void | kProfileProbe_StartEx (kProfileProbe probe, kProfileContext *context) |
| Begins a thread-safe code profiling measurement. More... | |
| void | kProfileProbe_Stop (kProfileProbe probe) |
| Ends a code profiling measurement. More... | |
| void | kProfileProbe_StopEx (kProfileProbe probe, kProfileContext *context) |
| Ends a thread-safe code profiling measurement. More... | |
Related | |
| #define | kProfileProbe_Start_(P) kxProfileProbe_Start_(P) |
| Macro version of kProfileProbe_Start. | |
| #define | kProfileProbe_Stop_(P) kxProfileProbe_Stop_(P) |
| Macro version of kProfileProbe_Stop. | |
| #define | kProfileProbe_StartEx_(P, C) kxProfileProbe_StartEx_(P, C) |
| Macro version of kProfileProbe_StartEx. | |
| #define | kProfileProbe_StopEx_(P, C) kxProfileProbe_StopEx_(P, C) |
| Macro version of kProfileProbe_StopEx. | |
