From 520294589497042f6b4d358233b8aad5ad5ed4eb Mon Sep 17 00:00:00 2001 From: DylanB95EST Date: Thu, 4 Aug 2022 14:16:33 +0100 Subject: [PATCH] State Model RTD Add Read The Doc documentation for CM-Handle state model Briefly explain all 5 potnetial cm handle states Issue-ID: CPS-1162 Change-Id: Iee52f9c280929337abf4aac2f5c9bbfb1edde30f Signed-off-by: DylanB95EST --- docs/modeling.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/modeling.rst b/docs/modeling.rst index 80cfdeaaf6..7cc2c4ce6a 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -83,6 +83,20 @@ Basic Concepts These are stored as Anchors within CPS-Core. + - **CM-Handle States** are used to represent the potential states in which a CM-Handle can transition between. + + The 5 possible CM-Handle states are: ADVISED, READY, LOCKED, DELETING, DELETED + + **ADVISED** indicates that a CM-Handle has been registered successfully, and is waiting for the module synchronization process to sync the CM-Handle. + + **READY** indicates that the CM-Handle has been synced successfully. + + **LOCKED** indicates that the CM-Handle has not synced successfully. A retry mechanism within CPS will set the state back to ADVISED after a set time. + + **DELETING** indicates that the CM-Handle is currently being deleted. + + **DELETED** indicates that the CM-Handle has been deleted successfully. + - **Data-sync state** is the state of the data synchronization process of the CM-Handle There are 3 possibles states: NONE_REQUESTED, UNSYNCHRONIZED, SYNCHRONIZED -- 2.16.6