|
FireSync API
|
Represents a FireSync node identifier.
FireSync node identifers are 32-bit unsigned values. k32u is used instead of kNodeId throughout most of the FireSync API and FireSync applications. The kNodeId type is defined only to organize functions and macros that can be used to compose these 32-bit node identifiers.
For the most part, node identifers are synonymous with manufacturing serial numbers. However, with the introduction of host-local nodes to support distributed data processsing, the uppermost bit of the node id is now reserved to distinguish between local nodes and primary/network nodes. This convention provides a namespace so that local node ids can be defined without risk of conflicting with primary node ids. This use of the uppermost bit to identify local nodes is strictly optional; it is valid to create local nodes identifiers without setting this bit.
Public Member Functions | |
| kNodeId | kNodeId_Create (kBool isLocal, k32u serialNumber) |
| Composes a node identifier from its constituent parts. More... | |
| kStatus | kNodeId_Format (kNodeId id, kChar *buffer, kSize capacity) |
| Formats a kNodeId value to a string buffer. More... | |
| kBool | kNodeId_IsLocal (kNodeId id) |
| Reports whether a node identifier represents a local coprocessing node. More... | |
| kStatus | kNodeId_Parse (kNodeId *id, const kChar *buffer) |
| Parses a kNodeId value from a string buffer. More... | |
| k32u | kNodeId_SerialNumber (kNodeId id) |
| Extracts the serial number from a node identifier. More... | |
