FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHxNullNode Class Reference

Description

Provides a software-only backend for kSvNode.

kHxNullNode is intended for use by applications to create a kSvNode instance without a strong association to the underlying device on which the server is running (a software-only, or "null" device). This kind of node is unable to perform most kHxNode operations, such as firmware upgrades or system resets, but is able to support network communication. Multiple kHxNullNode instances can be created on the same device.

By default, kHxNullNode instances behave as though they are configured to use the loopback network adapter. To participate in communication beyond the local device, use one of the available kHxNullNode configuration methods (e.g., kHxNullNode_AddNetInterfaceByAddress) to create an association between this node and a different network adapter.

Inheritance diagram for kHxNullNode:
Inheritance graph

Public Member Functions

kStatus kHxNullNode_AddNetInterfaceByAddress (kHxNullNode node, kIpAddress address)
 Creates an association between this node and a particular network adapter, specified by adapter IP address. More...
 
kStatus kHxNullNode_AddNetInterfaceByName (kHxNullNode node, const kChar *name)
 Creates an association between this node and a particular network adapter, specified by adapter name. More...
 
kStatus kHxNullNode_AddNetInterfaceByNetwork (kHxNullNode node, kIpAddress address)
 Creates an association between this node and a particular network adapter, specified by adapter network. More...
 
kStatus kHxNullNode_Construct (kHxNullNode *node, k32u nodeId, kHealth health, const kChar *storagePath, kAlloc allocator)
 Constructs a kHxNullNode instance. More...
 
kStatus kHxNullNode_EnableGlobalLog (kHxNullNode node, kBool enable)
 Enables this node to capture global log messages. More...
 

The documentation for this class was generated from the following file: