|
FireSync API
|
Represents the current state of a node object.
Public Member Functions | |
| kStatus | kNodeState_Format (kNodeState state, kChar *text, kSize capacity) |
| Formats a kNodeState value to a string buffer. More... | |
| kBool | kNodeState_IsConfigurable (kNodeState state) |
| Reports whether the given state implies that a device will accept configuration via control channel. More... | |
| kBool | kNodeState_IsConnectable (kNodeState state) |
| Reports whether the given state implies the potential for a successful control channel connection. More... | |
| kBool | kNodeState_IsNormal (kNodeState state) |
| Reports whether the given state implies that a device is operating normally. More... | |
| kBool | kNodeState_IsReadable (kNodeState state) |
| Reports whether the given state implies that configuration is readable via control channel. More... | |
| kBool | kNodeState_IsResponsive (kNodeState state) |
| Reports whether the given state implies responsiveness via control channel. More... | |
Related | |
| #define | kNODE_STATE_ONLINE (0) |
| Node disconnected, but detected via discovery. | |
| #define | kNODE_STATE_OFFLINE (1) |
| Node disconnected and no longer detected via discovery (refresh system to remove sensor). | |
| #define | kNODE_STATE_RESETTING (2) |
| Node disconnected and currently resetting (wait for completion). | |
| #define | kNODE_STATE_INCOMPATIBLE (3) |
| Node connected, but protocol incompatible with client (upgrade required). | |
| #define | kNODE_STATE_INCONSISTENT (4) |
| Node connected, but remote state was changed (refresh sensor). | |
| #define | kNODE_STATE_UNRESPONSIVE (5) |
| Node connected, but no longer detected via health or discovery (disconnect). | |
| #define | kNODE_STATE_CANCELLED (6) |
| Node connected, but communication aborted via kNode_Cancel function (disconnect or refresh sensor). | |
| #define | kNODE_STATE_READY (7) |
| Node connected and ready to accept configuration commands. | |
| #define | kNODE_STATE_PAUSED (8) |
| Node connected and currently paused. | |
| #define | kNODE_STATE_RUNNING (9) |
| Node connected and currently running. | |
| #define | kNODE_STATE_REPLAY (10) |
| Node connected and ready to accept replay commands. | |
