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 
13 kBeginHeader()
14 
15 
20 //typedef kObject kHealth; --forward-declared in kFsDef.x.h
21 
22 
30 kFsFx(kStatus) kHealth_Construct(kHealth* health, kAlloc allocator);
31 
44 kFsFx(kStatus) kHealth_AddUpdateHandler(kHealth health, kCallbackFx function, kPointer receiver);
45 
55 kFsFx(kStatus) kHealth_RemoveUpdateHandler(kHealth health, kCallbackFx function, kPointer receiver);
56 
64 kFsFx(kStatus) kHealth_Start(kHealth health);
65 
73 kFsFx(kStatus) kHealth_Stop(kHealth health);
74 
85 kFsFx(kStatus) kHealth_HealthStats(kHealth health, kArrayList stats);
86 
97 kFsFx(kStatus) kHealth_ProfileStats(kHealth health, kArrayList stats);
98 
108 kFsFx(k64u) kHealth_UpdatePeriod(kHealth health);
109 
110 #include <kFireSync/Health/kHealth.x.h>
111 
112 kEndHeader()
113 
114 #endif
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 current health statistics.
kHealth::kHealth_ProfileStats
kStatus kHealth_ProfileStats(kHealth health, kArrayList stats)
Gets current code profiling statistics.
kHealth::kHealth_Stop
kStatus kHealth_Stop(kHealth health)
Stops periodic health polling callbacks.
kHealth::kHealth_Start
kStatus kHealth_Start(kHealth health)
Starts periodic health polling callbacks.
kNodeDef.h
Essential declarations related to FireSync nodes.
kHealth::kHealth_UpdatePeriod
k64u kHealth_UpdatePeriod(kHealth health)
Reports the health polling period.
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_Construct
kStatus kHealth_Construct(kHealth *health, kAlloc allocator)
Constructs a kHealth object.