FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kUpgActionRunner.h
Go to the documentation of this file.
1 
8 #ifndef kFS_UPG_ACTION_RUNNER_H
9 #define kFS_UPG_ACTION_RUNNER_H
10 
11 #include <kFireSync/kFsDef.h>
12 #include <kApi/Utils/kEvent.h>
13 #include <kFireSync/Upgrade/kUpgAction.h>
14 #include <kFireSync/Client/kSystem.h>
15 #include <kFireSync/Client/kNode.h>
16 #include <kFireSync/Data/kArchive.h>
17 
25 typedef kObject kUpgActionRunner;
26 
28 kDeclareClassEx(kFs, kUpgActionRunner, kObject)
29 kDeclareValueEx(kFs, kUpgActionRunnerSensor, kValue)
32 kFsFx(kStatus) kUpgActionRunner_Construct(kUpgActionRunner* runner, kSystem system, kArchive archive, kAlloc alloc);
33 
34 kFsFx(kStatus) kUpgActionRunner_ClearSensors(kUpgActionRunner runner);
35 kFsFx(kStatus) kUpgActionRunner_AddSensor(kUpgActionRunner runner, k32u nodeId);
36 kFsFx(kSize) kUpgActionRunner_SensorCount(kUpgActionRunner runner);
37 
38 kFsFx(kStatus) kUpgActionRunner_SetLogEvent(kUpgActionRunner runner, kEvent event);
39 
40 kFsFx(kStatus) kUpgActionRunner_AddAction(kUpgActionRunner runner, kSize index, kUpgAction action);
41 kFsFx(kStatus) kUpgActionRunner_AddReset(kUpgActionRunner runner, kSize index);
42 kFsFx(kStatus) kUpgActionRunner_AddActionToAllSensors(kUpgActionRunner runner, kUpgAction action);
43 
44 kFsFx(kStatus) kUpgActionRunner_Run(kUpgActionRunner runner);
45 kFsFx(k32u) kUpgActionRunner_Progress(kUpgActionRunner runner); // this is thread safe with Upgrade
46 
47 #endif
kArchive.h
Declares the kArchive class.
kDeclareClassEx
#define kDeclareClassEx(PREFIX, SYMBOL, BASE)
kSystem.h
Declares the kSystem type.
kUpgAction.h
Declares the kUpgAction class.
kFsDef.h
Essential API declarations for the kFireSync library.
kUpgActionRunner
Executes sequences of upgrade actions (concurrently when applicable).
kNode.h
Declares the kNode type.
kSystem
Represents a collection of FireSync nodes (sensors).
kUpgAction
Represents an upgrade action (e.g.