FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLocalNode.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_LOCAL_NODE_H
9 #define K_FIRESYNC_LOCAL_NODE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
23 //typedef kObject kLocalNode; --forward-declared in kFsDef.x.h
24 
25 
31 kFsFx(kStatus) kLocalNode_Construct(kLocalNode* node, kLocalDiscovery discovery, k32u nodeId, kHealth health, const kChar* storagePath, kAlloc msgAlloc, kAlloc allocator);
32 
33 kFsFx(k32u) kLocalNode_Id(kLocalNode node);
34 kFsFx(k64u) kLocalNode_UpTime(kLocalNode node);
35 kFsFx(kBool) kLocalNode_HasStorage(kLocalNode node);
36 kFsFx(const kChar*) kLocalNode_StoragePath(kLocalNode node);
37 kFsFx(kHealth) kLocalNode_Health(kLocalNode node);
38 kFsFx(kAlloc) kLocalNode_MessageAlloc(kLocalNode node);
39 kFsFx(kLocalPipe) kLocalNode_Pipe(kLocalNode node);
40 
41 kFsFx(kStatus) kLocalNode_SetMessageAlloc(kLocalNode node, kAlloc alloc);
42 
43 kFsFx(kBool) kLocalNode_IsRemote(kLocalNode node);
44 
45 kFsFx(kStatus) kLocalNode_OpenControl(kLocalNode node);
46 kFsFx(kStatus) kLocalNode_CloseControl(kLocalNode node);
47 kFsFx(kStatus) kLocalNode_SetHealthHandler(kLocalNode node, kCallbackFx function, kPointer receiver);
48 kFsFx(kStatus) kLocalNode_OpenHealth(kLocalNode node);
49 kFsFx(kStatus) kLocalNode_CloseHealth(kLocalNode node);
50 kFsFx(kStatus) kLocalNode_SetDataHandler(kLocalNode node, kCallbackFx function, kPointer receiver);
51 kFsFx(kStatus) kLocalNode_OpenData(kLocalNode node, const k16u* ports, kSize portCount);
52 kFsFx(kStatus) kLocalNode_CloseData(kLocalNode node);
53 
54 kFsFx(kStatus) kLocalNode_WriteFile(kLocalNode node, const kChar* path, kStream stream, kSize size, kCallbackFx progress, kPointer context);
55 kFsFx(kStatus) kLocalNode_CopyFile(kLocalNode node, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);
56 kFsFx(kStatus) kLocalNode_ReadFile(kLocalNode node, const kChar* path, kStream stream, kCallbackFx progress, kPointer context);
57 kFsFx(kStatus) kLocalNode_DeleteFile(kLocalNode node, const kChar* path);
58 kFsFx(kStatus) kLocalNode_GetFileInfo(kLocalNode node, const kChar* path, kNodeFileInfo* info);
59 kFsFx(kStatus) kLocalNode_CreateDirectory(kLocalNode node, const kChar* path);
60 kFsFx(kStatus) kLocalNode_DeleteDirectory(kLocalNode node, const kChar* path);
61 kFsFx(kStatus) kLocalNode_ListDirectoryEntries(kLocalNode node, const kChar* path, kBool includeFiles, kBool includeDirectories, kArrayList entries);
62 
63 kFsFx(kStatus) kLocalNode_SetDeviceConfig(kLocalNode node, kXml xml, k64u revisionId);
64 kFsFx(kStatus) kLocalNode_GetDeviceConfig(kLocalNode node, kXml xml, k64u* revisionId);
65 kFsFx(kStatus) kLocalNode_CommitDeviceConfig(kLocalNode node);
66 kFsFx(kStatus) kLocalNode_SaveDeviceConfigFile(kLocalNode node);
67 kFsFx(kStatus) kLocalNode_SetModeConfig(kLocalNode node, kXml xml, k64u revisionId);
68 kFsFx(kStatus) kLocalNode_GetModeConfig(kLocalNode node, kXml xml, k64u* revisionId);
69 kFsFx(kStatus) kLocalNode_SaveModeConfig(kLocalNode node, const kChar* path);
70 kFsFx(kStatus) kLocalNode_LoadModeConfig(kLocalNode node, const kChar* path);
71 kFsFx(kStatus) kLocalNode_CommitModeConfig(kLocalNode node);
72 kFsFx(kStatus) kLocalNode_ValidateBlockConfig(kLocalNode node, kXml config);
73 
74 kFsFx(kStatus) kLocalNode_SetVariable(kLocalNode node, const kChar* name, kObject variable);
75 kFsFx(kStatus) kLocalNode_GetVariable(kLocalNode node, const kChar* name, kObject* variable, kAlloc alloc);
76 kFsFx(kStatus) kLocalNode_GetVariableInfo(kLocalNode node, const kChar* name, kNodeVariableInfo* info);
77 kFsFx(kStatus) kLocalNode_DeleteVariable(kLocalNode node, const kChar* name);
78 kFsFx(kStatus) kLocalNode_ListVariables(kLocalNode node, kArrayList variables);
79 
80 kFsFx(kStatus) kLocalNode_Start(kLocalNode node);
81 kFsFx(kStatus) kLocalNode_Stop(kLocalNode node);
82 kFsFx(kStatus) kLocalNode_Pause(kLocalNode node);
83 kFsFx(kStatus) kLocalNode_Resume(kLocalNode node);
84 kFsFx(kStatus) kLocalNode_Engage(kLocalNode node, k64u startTime, k64s startEncoder);
85 
86 kFsFx(kStatus) kLocalNode_StartReplay(kLocalNode node);
87 kFsFx(kStatus) kLocalNode_Replay(kLocalNode node, kObject input, kArrayList output);
88 
89 kFsFx(kStatus) kLocalNode_GetInfo(kLocalNode node, kNodeInfo* info);
90 kFsFx(kStatus) kLocalNode_GetState(kLocalNode node, kNodeStateInfo* info);
91 kFsFx(kStatus) kLocalNode_GetNodeStats(kLocalNode node, kNodeStats* stats);
92 
93 kEndHeader()
94 
95 #include <kFireSync/Local/kLocalNode.x.h>
96 
97 #endif
Represents detailed information about node hardware/firmware.
Definition: kNodeDef.h:1929
Represents information about a remote variable.
Definition: kNodeDef.h:1986
Essential declarations related to FireSync nodes.
Base class for a health statistics collection service.
Represents node run-time statistics.
Definition: kNodeDef.h:1960