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

Description

Base class for a health statistics collection service.

Note, this class is intended to be used primarily in the implementation of the FireSync platform, rather than directly by applications. However, there may be rare occasions in which it would be appropriate to use this class directly in an application (e.g., standalone desktop application that manages its own health functionality).

Inheritance diagram for kHealth:
Inheritance graph

Public Member Functions

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 latest streamed health statistics. More...
 
kStatus kHealth_Log (kHealth health, kHealthLog *log)
 Gets a reference to the health log (if installed). More...
 
kStatus kHealth_PersistentHealthStats (kHealth health, kArrayList stats)
 Gets latest persistent 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_SetLog (kHealth health, kHealthLog log)
 Installs a health logger. More...
 
kStatus kHealth_UpdateHealthStats (kHealth health)
 Invokes health update handlers. More...
 

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