swu_update_state_t

Possible states of a software update

Synopsis:

#include <swu/Common.h>
 
typedef enum {
      SWU_UPDATE_STATE_NEW = 0x00000001,   
      SWU_UPDATE_STATE_VERIFYING = 0x00000080,   
      SWU_UPDATE_STATE_VERIFIED = 0x00000100,   
      SWU_UPDATE_STATE_INSTALLING = 0x00000200,   
      SWU_UPDATE_STATE_INSTALL_COMPLETED = 0x00000400,   
      SWU_UPDATE_STATE_INSTALL_FAILED = 0x00000800,   
      SWU_UPDATE_STATE_INSTALL_CANCELLING = 0x00001000,   
      SWU_UPDATE_STATE_INSTALL_CANCELLED = 0x00002000,   
      SWU_UPDATE_STATE_INSTALL_VERIFYING = 0x00004000,   
      SWU_UPDATE_STATE_INSTALL_VERIFIED = 0x00008000,   
      SWU_UPDATE_STATE_ROLLING_BACK = 0x00010000,   
      SWU_UPDATE_STATE_ROLLBACK_COMPLETED = 0x00020000,   
      SWU_UPDATE_STATE_ROLLBACK_FAILED = 0x00040000,   
      SWU_UPDATE_STATE_ERROR = 0x00080000,   
      SWU_UPDATE_STATE_DECLINED = 0x00100000  
} swu_update_state_t;

Data:

SWU_UPDATE_STATE_NEW
The Update object has been created.
SWU_UPDATE_STATE_VERIFYING
The update is being verified.
SWU_UPDATE_STATE_VERIFIED
The update has passed internal verification.
SWU_UPDATE_STATE_INSTALLING
The user accepted the update and the system has started installing it.
SWU_UPDATE_STATE_INSTALL_COMPLETED
The update installation successfully completed.
SWU_UPDATE_STATE_INSTALL_FAILED
The update installation or the verification of the installation failed.
SWU_UPDATE_STATE_INSTALL_CANCELLING
The update is being cancelled by the user. This state is currently unused.
SWU_UPDATE_STATE_INSTALL_CANCELLED
The update was cancelled by the user. This state is currently unused.
SWU_UPDATE_STATE_INSTALL_VERIFYING
The UpdateTarget is verifying an update after successfully installing it.
SWU_UPDATE_STATE_INSTALL_VERIFIED
The update installation was successfully verified.
SWU_UPDATE_STATE_ROLLING_BACK
The update is being rolled back by the user. This state is currently unused.
SWU_UPDATE_STATE_ROLLBACK_COMPLETED
The update was rolled back by the user. This state is currently unused.
SWU_UPDATE_STATE_ROLLBACK_FAILED
The update rollback failed. This state is currently unused.
SWU_UPDATE_STATE_ERROR
An unexpected error occurred.
SWU_UPDATE_STATE_DECLINED
The user didn't accept the update.

Library:

libswu-core

Use the -l swu-core option with qcc to link against the SWU library. This library is usually included automatically.

Description:

The swu_update_state_t enumeration defines the possible states of a software update. These enumeration constants are defined in a way that allows one or many constants to be used in a bitmask when defining notifications.

The swu_update_state_to_string() function returns the string representation of an swu_update_state_t code, which is helpful for logging.