FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHostHealth Class Reference

Description

Provides health service for a typical host application.

This class extends kHealth to add support for some health indicators typically desired on host systems (e.g., cpu utilization). This class can be instantiated by a host application and installed as the global health provider for the application.

Inheritance diagram for kHostHealth:
Inheritance graph

Public Member Functions

kStatus kHostHealth_Construct (kHostHealth *health, kAlloc allocator)
 Constructs a kHostHealth object. More...
 
- Public Member Functions inherited from kHealth
kStatus kHealth_AddUpdateHandler (kHealth health, kCallbackFx function, kPointer receiver)
 Registers a callback for periodic health polling. More...
 
kStatus kHealth_Construct (kHealth *health, kAlloc allocator)
 Constructs a kHealth object. More...
 
kStatus kHealth_HealthStats (kHealth health, kArrayList stats)
 Gets current health statistics. More...
 
kStatus kHealth_ProfileStats (kHealth health, kArrayList stats)
 Gets current code profiling statistics. More...
 
kStatus kHealth_RemoveUpdateHandler (kHealth health, kCallbackFx function, kPointer receiver)
 Unregisters a callback from periodic health polling. More...
 
kStatus kHealth_Start (kHealth health)
 Starts periodic health polling callbacks. More...
 
kStatus kHealth_Stop (kHealth health)
 Stops periodic health polling callbacks. More...
 
k64u kHealth_UpdatePeriod (kHealth health)
 Reports the health polling period. More...
 

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