8 #ifndef K_FIRESYNC_SYSTEM_H
9 #define K_FIRESYNC_SYSTEM_H
877 #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_Apply(kSystem system)
Sends current settings to all modified nodes.
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_StartDiscovery(kSystem system)
Starts discovery client.
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.
kSize kSystem_DataQueueSize(kSystem system)
Reports the maximum total data size of all items in the data queue.
kStatus(kCall * kNodeFilterFx)(kPointer receiver, kObject sender, k32u nodeId)
Callback signature used with the kSystem_SetNodeFilter function.
Definition: kNodeDef.h:3113
kStatus kSystem_SetNodeFilter(kSystem system, kNodeFilterFx filter, kPointer receiver)
Registers a callback function that can be used to filter discovered nodes.
kStatus kSystem_ConstructEx(kSystem *system, kAlloc allocator)
Constructs a kSystem object without automatically starting discovery clients.
kStatus kSystem_StartNodes(kSystem system)
Prepares all connected nodes to be started.
kStatus kSystem_ConstructServerSystem(kSystem *system, kSvNode *serverNode, kAlloc allocator)
Constructs a kSystem object and adds a server node that is bound to the hardware platform singleton n...
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_StopDiscovery(kSystem system)
Stops discovery client.
Abstract base class for hardware node classes.
kStatus kSystem_Connect(kSystem system)
Attempts to connects to all discovered nodes.
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_ClearDiscovery(kSystem system)
Removes all discovery providers and adapters from the system.
kStatus kSystem_AddDiscoveryAdapter(kSystem system, const kChar *interfaceName)
Specifies a network adapter to be used for discovery.
kStatus kSystem_Stop(kSystem system)
Ends data sessions and stops all connected sensors.
kStatus kSystem_ClearData(kSystem system)
Clears all data from the data queue.
kStatus kSystem_AddServerNode(kSystem system, kHxNode hardwareNode, kSvNode *serverNode)
Adds a server node to the system.
kBool kSystem_HasChanges(kSystem system)
Reports whether the system has changes that require a refresh.
kStatus kSystem_CloseHealth(kSystem system)
Closes all health channels.
kStatus kSystem_SetDataQueueSize(kSystem system, kSize size)
Sets the maximum amount of data retained by the data queue.
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_RemoveDiscovery(kSystem system, kType providerType)
Removes a discovery provider from the system.
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_RemoveAllServerNodes(kSystem system)
Removes all server nodes from the system.
kStatus kSystem_SetDataHandler(kSystem system, kCallbackFx function, kPointer receiver)
Registers a callback function that can be used to receive data messages.
kSize kSystem_WarningCount(kSystem system)
Returns the number of warnings that were detected when the system was last verified.
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.
kStatus kSystem_WarningAt(kSystem system, kSize index, kChar *warning, kSize capacity)
Gets the verification warning string at the specified index.
kSize kSystem_NodeCount(kSystem system)
Reports the number of nodes in the system.
kStatus kSystem_FindDiscoveryProvider(kSystem system, kType providerType, kDiscoveryProvider *provider)
Locates the specified discovery provider.
Represents a health channel message sent by a node.
kStatus kSystem_RemoveServerNode(kSystem system, k32u nodeId)
Removes a server node from the system.
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_ClearHealth(kSystem system)
Clears all health messages from the health queue.
Provides FireSync node network services and mediates access to node hardware.
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.
