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 #include <kFireSync/Health/kHealthProbe.x.h>
13 
70 //typedef kObject kHealthProbe; --forward-declared in kFsDef.x.h
71 
87 kInlineFx(kStatus) kHealthProbe_Construct(kHealthProbe* probe, const kChar* name, k32u id, k32u instance, k64s initialValue, kAlloc allocator)
88 {
89  return xkHealthProbe_ConstructImpl(probe, name, id, instance, initialValue, kNULL, kHEALTH_OPTION_STREAM, allocator);
90 }
91 
108 kInlineFx(kStatus) kHealthProbe_Construct(kHealthProbe* probe, const kChar* name, k32u id, k32u instance, k64s defaultValue, kHealth provider, kHealthOption options, kAlloc allocator)
109 {
110  return xkHealthProbe_ConstructImpl(probe, name, id, instance, defaultValue, provider, options, allocator);
111 }
112 
126 {
127  return xkHealthProbe_VTable(probe)->VSetValue(probe, value);
128 }
129 
139 {
140  return xkHealthProbe_VTable(probe)->VAddValue(probe, value);
141 }
142 
162 {
163  return xkHealthProbe_VTable(probe)->VSetBaseline(probe, baseline);
164 }
165 
178 {
179  return xkHealthProbe_VTable(probe)->VUpdateBaseline(probe);
180 }
181 
193 {
194  return xkHealthProbe_VTable(probe)->VValue(probe);
195 }
196 
205 {
206  kObj(kHealthProbe, probe);
207 
208  return obj->name;
209 }
210 
219 {
220  kObj(kHealthProbe, probe);
221 
222  return obj->id;
223 }
224 
233 {
234  kObj(kHealthProbe, probe);
235 
236  return obj->instance;
237 }
238 
247 {
248  kObj(kHealthProbe, probe);
249 
250  return obj->options;
251 }
252 
253 #endif
254 
255 
k32u kHealthProbe_Instance(kHealthProbe probe)
Reports the instance of the health probe.
Definition: kHealthProbe.h:232
const kChar * kHealthProbe_Name(kHealthProbe probe)
Reports the name of the health probe.
Definition: kHealthProbe.h:204
#define kInlineFx(TYPE)
kStatus kHealthProbe_SetBaseline(kHealthProbe probe, k64s baseline)
Sets the baseline value.
Definition: kHealthProbe.h:161
k32u kHealthProbe_Id(kHealthProbe probe)
Reports the ID of the health probe.
Definition: kHealthProbe.h:218
Represents a bitset of health probe options.
Essential declarations related to FireSync nodes.
#define kHEALTH_OPTION_STREAM
Send probe via health updates.
Definition: kNodeDef.h:2726
Base class for a health statistics collection service.
#define kObj(TypeName_T, T_object)
kStatus kHealthProbe_SetValue(kHealthProbe probe, k64s value)
Sets the current value of a health probe.
Definition: kHealthProbe.h:125
Represents a health probe.
kHealthOption kHealthProbe_Options(kHealthProbe probe)
Reports the options associated with the indicator.
Definition: kHealthProbe.h:246
#define kNULL
kStatus kHealthProbe_UpdateBaseline(kHealthProbe probe)
Transfers the current probe value to the baseline.
Definition: kHealthProbe.h:177
k64s kHealthProbe_Value(kHealthProbe probe)
Reports the current value of the health probe.
Definition: kHealthProbe.h:192
kStatus kHealthProbe_AddValue(kHealthProbe probe, k64s value)
Adds an amount to the current value of a health probe.
Definition: kHealthProbe.h:138
kStatus kHealthProbe_Construct(kHealthProbe *probe, const kChar *name, k32u id, k32u instance, k64s initialValue, kAlloc allocator)
Constructs a kHealthProbe object with default provider and options.
Definition: kHealthProbe.h:87