|
FireSync API
|
Provides FireSync node network services and mediates access to node hardware.
Public Member Functions | |
| kPointer | kSvNode_App (kSvNode node) |
| Gets a reference to the application object. More... | |
| kStatus | kSvNode_DynamicIpConfig (kSvNode node, kSize index, kIpConfig *ipConfig) |
| Reports the current IP address configuration for this device, which can be dynamically updated due to DHCP activity. More... | |
| kStatus | kSvNode_EnableWatchdog (kSvNode node, kBool enable, k64u timeoutPeriod, k64u checkPeriod, kSvWatchdogFx callback, kPointer receiver) |
| Enables or disables the watchdog timer. More... | |
| kBool | kSvNode_HasStorage (kSvNode node) |
| Reports whether the node supports local file storage. More... | |
| kBool | kSvNode_HasWatchdog (kSvNode node) |
| Reports whether a watchdog timer is available on this platform. More... | |
| k32u | kSvNode_Id (kSvNode node) |
| Reports the device id of this node. More... | |
| kStatus | kSvNode_Log (kSvNode node, const kChar *message) |
| Writes to the server node log. More... | |
| kStatus | kSvNode_Log (kSvNode node, kLogOption options, const kChar *source, const kChar *message) |
| Writes to the server node log. More... | |
| kStatus | kSvNode_Logf (kSvNode node, const kChar *format,...) |
| Writes to the server node log. More... | |
| kStatus | kSvNode_Logf (kSvNode node, kLogOption options, const kChar *source, const kChar *format,...) |
| Writes to the server node log. More... | |
| kStatus | kSvNode_Logvf (kSvNode node, const kChar *format, kVarArgList argList) |
| Variable-argument version of kSvNode_Logf. More... | |
| kStatus | kSvNode_Logvf (kSvNode node, kLogOption options, const kChar *source, const kChar *format, kVarArgList argList) |
| Variable-argument version of kSvNode_Logf. More... | |
| kAlloc | kSvNode_MessageAlloc (kSvNode node) |
| Gets a memory allocator that is suitable for quickly allocating numerous, short-lived objects. More... | |
| k32u | kSvNode_NextDiscoveryPort (kSvNode node) |
| Reports the discovery port that will be used to broadcast information about this node. More... | |
| kStatus | kSvNode_NotifyShutdown (kSvNode node, kBool restartApp) |
| This function can be called to initiate application restart/shutdown, causing a pending call to the kSvNode_WaitForShutdown function to return. More... | |
| kStatus | kSvNode_PerformAction (kSvNode node, kPointer args) |
| Performs an action within an action handler callback. More... | |
| kStatus | kSvNode_SetActionHandler (kSvNode node, kCallbackFx function, kPointer receiver) |
| Registers a custom callback handler for incoming action requests. More... | |
| kStatus | kSvNode_SetAddressAndReset (kSvNode node, kSize index, const kIpConfig *ipConfig) |
| Sets network interface configuration and resets. More... | |
| kStatus | kSvNode_SetApp (kSvNode node, kPointer app) |
| Sets reference to application object. More... | |
| kStatus | kSvNode_SetAppInfo (kSvNode node, const kChar *name, kVersion version) |
| Sets application information that will be made available via the kNode_Info function. More... | |
| kStatus | kSvNode_SetWebHandler (kSvNode node, kCallbackFx function, kPointer receiver) |
| Registers a custom callback handler for incoming HTTP requests. More... | |
| kStatus | kSvNode_StartServices (kSvNode node, kSvNodeService services) |
| Starts node services (e.g., discovery/control servers). More... | |
| kStatus | kSvNode_StopServices (kSvNode node, kSvNodeService services) |
| Stops node services (e.g., discovery/control servers). More... | |
| const kChar * | kSvNode_StoragePath (kSvNode node) |
| Reports the root storage path, if the node supports local storage. More... | |
| kSystem | kSvNode_System (kSvNode node) |
| Gets the kSystem object that hosts this server. More... | |
| kStatus | kSvNode_UseEphemeralPorts (kSvNode node) |
| Specifies that auto-assigned, ephemeral ports should be used for control, health, data, and web services. More... | |
| kStatus | kSvNode_WaitForShutdown (kSvNode node, k64u timeout) |
| Blocks until this node is ready for shutdown. More... | |
| kStatus | kSvNode_WaitForSync (kSvNode node) |
| Blocks until configured method of synchronization is established. More... | |
