FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHealthLog.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_HEALTH_LOG_H
9 #define K_FIRESYNC_HEALTH_LOG_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 typedef kBool (kCall* kHealthLogPruneFx)(kPointer receiver);
20 
21 #include <kFireSync/Health/kHealthLog.x.h>
22 
29 //typedef kObject kHealthLog; --forward-declared in kFsDef.x.h
30 
45 kFsFx(kStatus) kHealthLog_Construct(kHealthLog* log, const kChar* directory, k32u fileLimit, k32u sizeLimit, k32u blockSize, kAlloc allocator);
46 
67 kFsFx(kStatus) kHealthLog_RegisterStat(kHealthLog log, kHealthId id, k32u instance, const kChar* name, kBool shouldRestore, k64s value);
68 
85 kFsFx(kStatus) kHealthLog_UnregisterStat(kHealthLog log, kHealthId id, k32u instance);
86 
101 kFsFx(kStatus) kHealthLog_FindStatValue(kHealthLog log, kHealthId id, k32u instance, k64s* value);
102 
114 kFsFx(kStatus) kHealthLog_Clear(kHealthLog log);
115 
126 kFsFx(kStatus) kHealthLog_CreateSnapshot(kHealthLog log, kArrayList statList);
127 
138 kFsFx(kStatus) kHealthLog_Summarize(kHealthLog log, kHealthSummary summary);
139 
140 #endif
kHealthId
Numeric identifier for a health statistic.
kHealthLog
Implements persistent health logging.
kHealthLog::kHealthLog_Construct
kStatus kHealthLog_Construct(kHealthLog *log, const kChar *directory, k32u fileLimit, k32u sizeLimit, k32u blockSize, kAlloc allocator)
Constructs a kHealthLog object.
kHealthLog::kHealthLog_FindStatValue
kStatus kHealthLog_FindStatValue(kHealthLog log, kHealthId id, k32u instance, k64s *value)
Gets the latest logged value of the specifid health stat.
kHealthLog::kHealthLog_UnregisterStat
kStatus kHealthLog_UnregisterStat(kHealthLog log, kHealthId id, k32u instance)
Notes that a stat has gone offline.
kHealthLog::kHealthLog_CreateSnapshot
kStatus kHealthLog_CreateSnapshot(kHealthLog log, kArrayList statList)
Adds a new snapshot to the health log.
kHealthSummary
Represents a summary of health log data.
kNodeDef.h
Essential declarations related to FireSync nodes.
kHealthLog::kHealthLog_Summarize
kStatus kHealthLog_Summarize(kHealthLog log, kHealthSummary summary)
Builds a log summary by scanning all snapshot files.
kHealthLog::kHealthLog_RegisterStat
kStatus kHealthLog_RegisterStat(kHealthLog log, kHealthId id, k32u instance, const kChar *name, kBool shouldRestore, k64s value)
Adds or updates metadata for the specified stat.
kHealthLog::kHealthLog_Clear
kStatus kHealthLog_Clear(kHealthLog log)
Marks the log to be cleared the next time that it is reloaded.
kHealthLogPruneFx
kBool(kCall * kHealthLogPruneFx)(kPointer receiver)
Callback signature to determine whether the log should be pruned to reclaim space.
Definition: kHealthLog.h:19