8 #ifndef K_FIRESYNC_SYSTEM_H
9 #define K_FIRESYNC_SYSTEM_H
769 #include <kFireSync/Client/kSystem.x.h>
kStatus kSystem_SetHostHealthProvider(kSystem system, kHealth provider, k32u id)
Installs a health provider that can be used to generate health statistics for the local host...
kStatus kSystem_StartRescue(kSystem system)
Starts broadcasting rescue request messages.
kStatus kSystem_EndDataSession(kSystem system)
Ends data collection from all connected nodes until the next time that nodes are started/resumed.
kStatus kSystem_ErrorAt(kSystem system, kSize index, kChar *error, kSize capacity)
Gets the verification error string at the specified index.
kStatus kSystem_ResumeNodes(kSystem system)
Prepares all connected nodes to be resumed.
kStatus kSystem_Apply(kSystem system)
Sends current settings to all modified nodes.
kStatus kSystem_AddLocalNode(kSystem system, k32u nodeId, kHealth health, const kChar *storagePath)
Adds a host-local data processing node to the system.
kStatus kSystem_ReceiveData(kSystem system, kMsgInfo *msg, k64u timeout)
Waits until at least one data message has been received and then returns the message.
kSize kSystem_DataNetBufferSize(kSystem system)
Gets the per-node network buffer size for data channels.
kStatus kSystem_PauseNodes(kSystem system)
Pauses all connected nodes.
kStatus kSystem_StartDiscovery(kSystem system)
Starts discovery services.
kNode kSystem_NodeAt(kSystem system, kSize index)
Gets the node at the specified index.
kStatus kSystem_Construct(kSystem *system, kAlloc allocator)
Constructs a kSystem object with default discovery providers.
Represents the type of a change within a sensor network.
kVersion kSystem_ProtocolVersion()
Reports the FireSync protocol version supported by this class.
kStatus kSystem_Refresh(kSystem system)
Updates client state to reflect any changes that have occurred in the node network.
kStatus kSystem_OpenData(kSystem system)
Opens data connections to all connected nodes.
kStatus kSystem_OpenHealth(kSystem system)
Opens health channels to all connected nodes.
kStatus kSystem_OpenHostHealth(kSystem system)
Opens channel to local host health provider.
kStatus kSystem_Disconnect(kSystem system)
Disconnects from all nodes.
kStatus kSystem_Verify(kSystem system)
Checks the validity of all system settings.
kSize kSystem_ErrorCount(kSystem system)
Returns the number of errors that were detected when the system was last verified.
kStatus kSystem_Resume(kSystem system)
Opens data connections and resumes all connected sensors.
kStatus kSystem_ConstructEx(kSystem *system, kAlloc allocator)
Constructs a kSystem object without any default discovery providers.
kStatus kSystem_StartNodes(kSystem system)
Prepares all connected nodes to be started.
kStatus kSystem_VerifyAndApply(kSystem system)
Checks for errors and applies settings if no errors are detected.
kStatus kSystem_EngageNodes(kSystem system, k64u startTime, k64s startEncoder)
Engages all connected nodes (finalizes a start or resume operation).
kStatus kSystem_StopNodes(kSystem system)
Stops all connected nodes.
Essential declarations related to FireSync nodes.
kStatus kSystem_RemoveAllLocalNodes(kSystem system)
Removes all host-local data processing nodes from the system.
kStatus kSystem_StopDiscovery(kSystem system)
Stops discovery services.
kStatus kSystem_Connect(kSystem system)
Attempts to connects to all discovered nodes.
kStatus kSystem_Pause(kSystem system)
Closes data connections and pauses all connected sensors.
Represents a FireSync node (sensor).
kStatus kSystem_ReceiveHealth(kSystem system, kHealthMsg *info, k64u timeout)
Waits until at least one health message has been received and then returns the message.
Base class for a health statistics collection service.
kStatus kSystem_Stop(kSystem system)
Closes data connections and stops all connected sensors.
kBool kSystem_HasChanges(kSystem system)
Reports whether the system has changes that require a refresh.
kStatus kSystem_CloseHealth(kSystem system)
Closes all health channels.
Represents a collection of FireSync nodes (sensors).
kStatus kSystem_FindNode(kSystem system, k32u id, kNode *node)
Finds the node with the specified id.
kStatus kSystem_SetDataNetBufferSize(kSystem system, kSize size)
Sets the per-node network buffer size for data channels.
kStatus kSystem_StopRescue(kSystem system)
Stops broadcasting rescue request messages.
kStatus kSystem_RemoveLocalNode(kSystem system, k32u nodeId)
Removes a host-local data processing node from the system.
kStatus kSystem_SetDataHandler(kSystem system, kCallbackFx function, kPointer receiver)
Registers a callback function that can be used to receive data messages.
kStatus kSystem_Start(kSystem system)
Opens data connections and starts all connected sensors.
kSystemChange kSystem_Changes(kSystem system)
Reports system changes that have occurred.
kStatus kSystem_RefreshEx(kSystem system, kBool forceAll, kArrayList removed, kArrayList added, kArrayList refreshed)
Updates client state to reflect any changes that have occurred in the node network.
kSize kSystem_NodeCount(kSystem system)
Reports the number of nodes in the system.
Represents a health channel message sent by a node.
kStatus kSystem_CloseData(kSystem system)
Closes data connections to all connected nodes.
kStatus kSystem_AddDiscovery(kSystem system, kDiscoveryProvider provider)
Adds a discovery provider to the system.
Represents message source information and an attached message.
kStatus kSystem_CloseHostHealth(kSystem system)
Closes channel to local host health provider.
kStatus kSystem_SetHealthHandler(kSystem system, kCallbackFx function, kPointer receiver)
Registers a callback function that can be used to receive health messages.
