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

Description

Represents a health probe.

Health probes are associated with a health collection provider. A default health collection provider may be installed by the application environment. If not, or if a more specific collection provider is desired, the kHealthProbe_ConstructEx constructor can be used to construct a probe and attach it to the specified provider.

Public Member Functions

kStatus kHealthProbe_AddValue (kHealthProbe probe, k64s value)
 Adds an amount to the current value of a health probe. More...
 
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. More...
 
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. More...
 
kStatus kHealthProbe_SetValue (kHealthProbe probe, k64s value)
 Sets the current value of a health probe. More...
 
k64s kHealthProbe_Value (kHealthProbe probe)
 Reports the current value of the health probe. More...
 

Related

#define kHealthProbe_SetValue_(P, V)   kxHealthProbe_SetValue_(P, V)
 Macro version of kHealthProbe_SetValue.
 
#define kHealthProbe_AddValue_(P, V)   kxHealthProbe_AddValue_(P, V)
 Macro version of kHealthProbe_AddValue.
 
#define kHealthProbe_Value_(P)   kxHealthProbe_Value_(P)
 Macro version of kHealthProbe_Value.
 

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