FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHealthProbe.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_HEALTH_PROBE_H
9 #define K_FIRESYNC_HEALTH_PROBE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
25 //typedef kObject kHealthProbe; --forward-declared in kFsDef.x.h
26 
27 
39 kFsFx(kStatus) kHealthProbe_Construct(kHealthProbe* probe, const kChar* name, k32u id, k32u instance, k64s initialValue, kAlloc allocator);
40 
54 kFsFx(kStatus) kHealthProbe_ConstructEx(kHealthProbe* probe, kHealth provider, const kChar* name, k32u id, k32u instance, k64s initialValue, kAlloc allocator);
55 
64 kFsFx(kStatus) kHealthProbe_SetValue(kHealthProbe probe, k64s value);
65 
74 kFsFx(kStatus) kHealthProbe_AddValue(kHealthProbe probe, k64s value);
75 
84 
86 #define kHealthProbe_SetValue_(P, V) kxHealthProbe_SetValue_(P, V)
87 #define kHealthProbe_AddValue_(P, V) kxHealthProbe_AddValue_(P, V)
88 #define kHealthProbe_Value_(P) kxHealthProbe_Value_(P)
89 
91 kEndHeader()
92 
93 #include <kFireSync/Health/kHealthProbe.x.h>
94 
95 #endif
96 
97 
Essential declarations related to FireSync nodes.
kStatus kHealthProbe_ConstructEx(kHealthProbe *probe, kHealth provider, const kChar *name, k32u id, k32u instance, k64s initialValue, kAlloc allocator)
Constructs a kHealthProbe object attached to the specified health provider.
Base class for a health statistics collection service.
kStatus kHealthProbe_SetValue(kHealthProbe probe, k64s value)
Sets the current value of a health probe.
Represents a health probe.
k64s kHealthProbe_Value(kHealthProbe probe)
Reports the current value of the health probe.
kStatus kHealthProbe_AddValue(kHealthProbe probe, k64s value)
Adds an amount to the current value of a health probe.
kStatus kHealthProbe_Construct(kHealthProbe *probe, const kChar *name, k32u id, k32u instance, k64s initialValue, kAlloc allocator)
Constructs a kHealthProbe object attached to the default health provider.