summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDylanB95EST <dylan.byrne@est.tech>2022-08-04 14:16:33 +0100
committerDylanB95EST <dylan.byrne@est.tech>2022-08-05 09:45:58 +0100
commit520294589497042f6b4d358233b8aad5ad5ed4eb (patch)
tree95d0eb6f4cf75bf2c8c5d6a70221ca240100b220
parente757875b53266683091b62d9906ceaa013e3ba89 (diff)
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 <dylan.byrne@est.tech>
-rw-r--r--docs/modeling.rst14
1 files changed, 14 insertions, 0 deletions
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