FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kNodeState Struct Reference

Description

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
 Node disconnected, but detected via discovery.
 
#define kNODE_STATE_OFFLINE
 Node disconnected and no longer detected via discovery (refresh system to remove sensor).
 
#define kNODE_STATE_RESETTING
 Node disconnected and currently resetting (wait for completion).
 
#define kNODE_STATE_INCOMPATIBLE
 Node connected, but protocol incompatible with client (upgrade required).
 
#define kNODE_STATE_INCONSISTENT
 Node connected, but remote state was changed (refresh sensor).
 
#define kNODE_STATE_UNRESPONSIVE
 Node connected, but no longer detected via health or discovery (disconnect).
 
#define kNODE_STATE_CANCELLED
 Node connected, but communication aborted via kNode_Cancel function (disconnect or refresh sensor).
 
#define kNODE_STATE_READY
 Node connected and ready to accept configuration commands.
 
#define kNODE_STATE_PAUSED
 Node connected and currently paused.
 
#define kNODE_STATE_RUNNING
 Node connected and currently running.
 
#define kNODE_STATE_REPLAY
 Node connected and ready to accept replay commands.
 

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