FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kUpgrader.h
Go to the documentation of this file.
1 
8 #ifndef kFS_UPGRADER_H
9 #define kFS_UPGRADER_H
10 
11 #include <kFireSync/kFsDef.h>
12 #include <kFireSync/Data/kArchive.h>
13 #include <kFireSync/Upgrade/kUpgActionRunner.h>
14 #include <kFireSync/Upgrade/kUpgCompat5.h>
15 #include <kApi/Utils/kEvent.h>
16 #include <kFireSync/Client/kSystem.h>
17 #include <kFireSync/Client/kNode.h>
18 #include <kFireSync/Data/kPropertyList.h>
19 
30 typedef kObject kUpgrader;
31 
33 kDeclareClassEx(kFs, kUpgrader, kObject)
34 kDeclareValueEx(kFs, kUpgraderNode, kValue)
45 kFsFx(kStatus) kUpgrader_Construct(kUpgrader* upgrader, kAlloc alloc);
46 
56 kFsFx(kStatus) kUpgrader_AddNode(kUpgrader upgrader, kNode node, kPropertyList properties);
57 
65 kFsFx(kSize) kUpgrader_NodeCount(kUpgrader upgrader);
66 
74 kFsFx(kStatus) kUpgrader_ClearNodes(kUpgrader upgrader);
75 
84 kFsFx(kStatus) kUpgrader_SetLocalNode(kUpgrader upgrader, k32u localNode);
85 
94 kFsFx(kStatus) kUpgrader_SkipValidation(kUpgrader upgrader, kBool skip);
95 
105 kFsFx(kStatus) kUpgrader_Run(kUpgrader upgrader, kSystem system, kArchive archive);
106 
117 kFsFx(kStatus) kUpgrader_Validate(kUpgrader upgrader, kArchive archive);
118 
129 kFsFx(kStatus) kUpgrader_ValidateFile(kUpgrader upgrader, const kChar* fileName);
130 
138 kFsFx(k32u) kUpgrader_Progress(kUpgrader upgrader);
139 
149 kFsFx(kEvent) kUpgrader_LogEvent(kUpgrader upgrader);
150 
151 #endif
kUpgrader::kUpgrader_LogEvent
kEvent kUpgrader_LogEvent(kUpgrader upgrader)
Allows to subscribe for log messages.
kArchive.h
Declares the kArchive class.
kUpgrader::kUpgrader_SkipValidation
kStatus kUpgrader_SkipValidation(kUpgrader upgrader, kBool skip)
Skips validation when applying the upgrade package.
kUpgrader::kUpgrader_Progress
k32u kUpgrader_Progress(kUpgrader upgrader)
Returns the current progress progress as value between 0 and 100.
kUpgrader
Performs upgrade using a supplied upgrade package.
kUpgrader::kUpgrader_NodeCount
kSize kUpgrader_NodeCount(kUpgrader upgrader)
Returns the number of nodes associated with the upgrader object.
kUpgActionRunner.h
Declares the kUpgActionRunner class.
kDeclareClassEx
#define kDeclareClassEx(PREFIX, SYMBOL, BASE)
kUpgrader::kUpgrader_Run
kStatus kUpgrader_Run(kUpgrader upgrader, kSystem system, kArchive archive)
Applies the upgrade package to all nodes.
kSystem.h
Declares the kSystem type.
kUpgrader::kUpgrader_Validate
kStatus kUpgrader_Validate(kUpgrader upgrader, kArchive archive)
Runs the validation only, without actually applying the upgrade package.
kNode
Represents a FireSync node (sensor).
kFsDef.h
Essential API declarations for the kFireSync library.
kUpgrader::kUpgrader_ClearNodes
kStatus kUpgrader_ClearNodes(kUpgrader upgrader)
Clears the nodes associated with the upgrader.
kNode.h
Declares the kNode type.
kSystem
Represents a collection of FireSync nodes (sensors).
kUpgrader::kUpgrader_SetLocalNode
kStatus kUpgrader_SetLocalNode(kUpgrader upgrader, k32u localNode)
Sets the ID of the local node.
kUpgrader::kUpgrader_AddNode
kStatus kUpgrader_AddNode(kUpgrader upgrader, kNode node, kPropertyList properties)
Adds a node and the associated properties.
kUpgCompat5.h
Declares the kUpgCompat5 class.
kUpgrader::kUpgrader_Construct
kStatus kUpgrader_Construct(kUpgrader *upgrader, kAlloc alloc)
Constructs an upgrader object.
kUpgrader::kUpgrader_ValidateFile
kStatus kUpgrader_ValidateFile(kUpgrader upgrader, const kChar *fileName)
Runs the validation only, without actually applying the upgrade package.