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

Description

Abstract base class for hardware node classes.

For the most part, the methods defined in this abstract base class are not intended for direct use by sensor application software. kHxNode (and its subordinate control objects) are intended for use in the FireSync Server framework (i.e., kFireSync/Server classes) to interface with underlying node hardware. The only exceptions to this rule are the kHxNode_PlatformInstance/kHxNode_FindPlatformInstance methods, which can be used to locate a suitable kHxNode object.

In general, the public methods in kHxNode and related classes are not thread-safe; it is up to the caller to guarantee exclusive access. kHxNode and its subordinate control objects should be considered as a single handle, designed for control by a single agent. In specific cases where methods are designed for concurrent access, this guarantee is noted in method documentation.

Inheritance diagram for kHxNode:
Inheritance graph

Public Member Functions

kStatus kHxNode_ConstructPlatformInstance (k32s argc, const kChar **argv)
 Constructs a hardware node object representing the underlying platform. More...
 
kStatus kHxNode_FindPlatformInstance (kHxNode *node)
 Locates a hardware node object representing the underlying platform. More...
 
kHxNode kHxNode_PlatformInstance ()
 Returns a reference to the hardware platform singleton, if it exists. More...
 

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