FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHealth.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_HEALTH_H
9 #define K_FIRESYNC_HEALTH_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
23 //typedef kObject kHealth; --forward-declared in kFsDef.x.h
24 
33 kFsFx(kStatus) kHealth_Construct(kHealth* health, kAlloc allocator);
34 
49 kFsFx(kStatus) kHealth_AddUpdateHandler(kHealth health, kCallbackFx function, kPointer receiver);
50 
62 kFsFx(kStatus) kHealth_RemoveUpdateHandler(kHealth health, kCallbackFx function, kPointer receiver);
63 
75 kFsFx(kStatus) kHealth_UpdateHealthStats(kHealth health);
76 
90 kFsFx(kStatus) kHealth_HealthStats(kHealth health, kArrayList stats);
91 
105 kFsFx(kStatus) kHealth_PersistentHealthStats(kHealth health, kArrayList stats);
106 
117 kFsFx(kStatus) kHealth_ProfileStats(kHealth health, kArrayList stats);
118 
138 kFsFx(kStatus) kHealth_SetLog(kHealth health, kHealthLog log);
139 
153 kFsFx(kStatus) kHealth_Log(kHealth health, kHealthLog* log);
154 
155 #include <kFireSync/Health/kHealth.x.h>
156 
157 #endif
kHealthLog
Implements persistent health logging.
kHealth::kHealth_SetLog
kStatus kHealth_SetLog(kHealth health, kHealthLog log)
Installs a health logger.
kHealth::kHealth_AddUpdateHandler
kStatus kHealth_AddUpdateHandler(kHealth health, kCallbackFx function, kPointer receiver)
Registers a callback for periodic health polling.
kHealth::kHealth_HealthStats
kStatus kHealth_HealthStats(kHealth health, kArrayList stats)
Gets latest streamed health statistics.
kHealth::kHealth_ProfileStats
kStatus kHealth_ProfileStats(kHealth health, kArrayList stats)
Gets current code profiling statistics.
kHealth::kHealth_Log
kStatus kHealth_Log(kHealth health, kHealthLog *log)
Gets a reference to the health log (if installed).
kNodeDef.h
Essential declarations related to FireSync nodes.
kHealth::kHealth_UpdateHealthStats
kStatus kHealth_UpdateHealthStats(kHealth health)
Invokes health update handlers.
kHealth
Base class for a health statistics collection service.
kHealth::kHealth_RemoveUpdateHandler
kStatus kHealth_RemoveUpdateHandler(kHealth health, kCallbackFx function, kPointer receiver)
Unregisters a callback from periodic health polling.
kHealth::kHealth_PersistentHealthStats
kStatus kHealth_PersistentHealthStats(kHealth health, kArrayList stats)
Gets latest persistent health statistics.
kHealth::kHealth_Construct
kStatus kHealth_Construct(kHealth *health, kAlloc allocator)
Constructs a kHealth object.