FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kUpgrader.z.h
1 #ifndef kFS_UPGRADER_Z_H
2 #define kFS_UPGRADER_Z_H
3 
8 #include <kFireSync/Upgrade/kUpgUtils.h>
10 
11 kBeginHeader()
12 
13 #define kFS_UPGRADER_VALIDATION_FILE "validation-2.xml"
14 #define kFS_UPGRADER_SCRIPT_FILE "script.xml"
15 #define kFS_UPGRADER_OLD_SCRIPT_FILE "description.xml"
16 
17 typedef struct
18 {
19  kNode node;
20  kPropertyList properties;
21 } kUpgraderNode;
22 
23 typedef struct
24 {
25  kObjectClass base;
26  kBool skipValidation;
27  kSystem system;
28  kArchive archive;
29  k32u localNode;
30  kArrayList nodes; //of kUpgraderNode
31  kUpgScript script;
32  kUpgCompat5 compat5;
33  kUpgActionRunner actionRunner;
34  kEvent logEvent;
35 } kUpgraderClass;
36 
37 #define kUpgrader_Cast_(CONTEXT) kCastClass_(kUpgrader, CONTEXT)
38 
39 kFsFx(kStatus) kUpgrader_Init(kUpgrader upgrader, kType type, kAlloc alloc);
40 kFsFx(kStatus) kUpgrader_VRelease(kUpgrader upgrader);
41 
42 kFsFx(kStatus) kUpgrader_Validate(kUpgrader upgrader, const kChar* validationFileName);
43 kFsFx(kStatus) kUpgrader_RunScript(kUpgrader upgrader);
44 kFsFx(kStatus) kUpgrader_RunTasks(kUpgrader upgrader);
45 kFsFx(kStatus) kUpgrader_CleanUp(kUpgrader upgrader);
46 
47 kFsFx(kStatus) kUpgrader_AddOps(kUpgrader upgrader, kUpgActionOp op, kUpgScriptRunner scriptRunner, kSize index);
48 
49 kFsFx(kBool) kUpgrader_HasFile(kUpgrader upgrader, const kChar* fileName);
50 kFsFx(kStatus) kUpgrader_LoadValidation(kUpgrader upgrader, const kChar* validationFileName, kUpgRuleSet* validation);
51 kFsFx(kStatus) kUpgrader_LoadScript(kUpgrader upgrader, kUpgScript* script);
52 kFsFx(kStatus) kUpgrader_LoadXml(kUpgrader upgrader, const kChar* fileName, kXml* xml);
53 kFsFx(kStatus) kUpgrader_ParseFirmwareType(kUpgrader upgrader, const kChar* name, kNodeFirmwareType* type);
54 
55 kFsFx(kUpgraderNode) kUpgrader_NodeAt(kUpgrader upgrader, kSize index);
56 
57 kFsFx(kArchive) kUpgrader_Archive(kUpgrader upgrader);
58 
59 kFsFx(kUpgActionRunner) kUpgrader_ActionRunner(kUpgrader upgrader);
60 kFsFx(kStatus) kUpgrader_CreateCompatFileAction(kUpgrader upgrader, kUpgCompat5Model model, kSize nodeIndex);
61 kFsFx(kStatus) kUpgrader_CreateCompatVersionAction(kUpgrader upgrader, kUpgCompat5Model model, kSize nodeIndex);
62 kFsFx(kStatus) kUpgrader_CreateCompatFirmwareActions(kUpgrader upgrader, kUpgCompat5Target target, kSize nodeIndex);
63 kFsFx(kStatus) kUpgrader_CreateCompatActions(kUpgrader upgrader);
64 
65 kEndHeader()
66 
67 #endif
Contains a set of validation criteria.
Performs upgrade using a supplied upgrade package.
Represents types of node firmware.
Declares the kUpgActionRunner class.
Declares the kUpgrader class.
Executes an upgrade script and produces a list of applicable actions.
Represents a FireSync node (sensor).
Represents a device upgrade package.
Declares the kUpgScriptRunner class.
Declares upgrade utilities.
Executes sequences of upgrade actions (concurrently when applicable).
Represents a collection of FireSync nodes (sensors).
Declares the kUpgCompat5 class.
Represents an upgrade script.