diff options
Diffstat (limited to 'docs/clamp/acm/api-protocol')
| -rwxr-xr-x[-rw-r--r--] | docs/clamp/acm/api-protocol/acm-participant-protocol.rst | 4 | ||||
| -rwxr-xr-x[-rw-r--r--] | docs/clamp/acm/api-protocol/puml/ParticipantDeregister.puml | 5 | ||||
| -rwxr-xr-x[-rw-r--r--] | docs/clamp/acm/api-protocol/puml/ParticipantRegister.puml | 25 | ||||
| -rwxr-xr-x[-rw-r--r--] | docs/clamp/acm/api-protocol/system-level-dialogues.rst | 2 |
4 files changed, 21 insertions, 15 deletions
diff --git a/docs/clamp/acm/api-protocol/acm-participant-protocol.rst b/docs/clamp/acm/api-protocol/acm-participant-protocol.rst index b4755ae2..ee9213cf 100644..100755 --- a/docs/clamp/acm/api-protocol/acm-participant-protocol.rst +++ b/docs/clamp/acm/api-protocol/acm-participant-protocol.rst @@ -19,11 +19,13 @@ Participant Registration and De-Registration -------------------------------------------- Participant Registration is performed by a Participant when it starts up. It registers its ID and the ACM Element Types it supports with the ACM runtime. +In a scenario where Participant has been restarted, ACM runtime have to provide all Primed ACM Definition and Deployed ACM instances of the Participant sending a Restart message. + .. image:: ../images/system-dialogues/RegisterParticipant.png -Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime. The participant should already have cleared down all its' ACM Element instances and set their states to “Not In Service”. +Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime. .. image:: ../images/system-dialogues/DeregisterParticipant.png diff --git a/docs/clamp/acm/api-protocol/puml/ParticipantDeregister.puml b/docs/clamp/acm/api-protocol/puml/ParticipantDeregister.puml index 8b6a18ea..acbec2ad 100644..100755 --- a/docs/clamp/acm/api-protocol/puml/ParticipantDeregister.puml +++ b/docs/clamp/acm/api-protocol/puml/ParticipantDeregister.puml @@ -1,5 +1,6 @@ @startuml -Participant -> CLAMP_Runtime: Participant Deregistration -Participant <- CLAMP_Runtime: Participant Deregistration Ack +Participant -> "ACM Runtime": [ASYNC] Deregister +"ACM Runtime" -> "ACM Database": Set Participant State as OFF_LINE +Participant <- "ACM Runtime": [ASYNC] Deregistration Accepted Participant -> Participant: Shutdown Participant @enduml diff --git a/docs/clamp/acm/api-protocol/puml/ParticipantRegister.puml b/docs/clamp/acm/api-protocol/puml/ParticipantRegister.puml index af42d571..f8aeee81 100644..100755 --- a/docs/clamp/acm/api-protocol/puml/ParticipantRegister.puml +++ b/docs/clamp/acm/api-protocol/puml/ParticipantRegister.puml @@ -1,17 +1,20 @@ @startuml activate Participant -Participant -> Participant: Start Participant + Participant -> "CLAMP Runtime": [ASYNC] Register +activate "CLAMP Runtime" deactivate Participant -Participant -> CLAMP_Runtime: Participant Registration -Participant <- CLAMP_Runtime: Participant Registration Ack -activate CLAMP_Runtime -loop over Automation Composition Type Definitions - CLAMP_Runtime -> CLAMP_Runtime: Collect Automation Composition Element Type Definitions and\nCommon Property Values for\nParticipant Type of this Participant -end -deactivate CLAMP_Runtime -Participant <- CLAMP_Runtime: Participant Update\n[Automation Composition Element Type Definitions and\nCommon Property Values for\nParticipant Type of Participant] + "CLAMP Runtime" -> "CLAMP Database": Create or Update Perticipant Registration,\n store supported ACM element types \n and set Perticipant State as ON_LINE + "CLAMP Runtime" -> Participant: [ASYNC] Registration Accepted + loop over ACM Definition + "CLAMP Runtime" -> "CLAMP Database": Mark all ACM element instances deployed\n on Participant as Restarting + "CLAMP Runtime" -> Participant: [ASYNC] Restart\n send Common Property Values\n and Instance Elements of this Participant] +deactivate "CLAMP Runtime" activate Participant -Participant -> Participant: Store Automation Composition Element Type Definitions and\nCommon Property Values -Participant -> CLAMP_Runtime: Participant Update Ack +Participant -> Participant: Store Common Property Values and Instance Elements +Participant -> "CLAMP Runtime": [ASYNC] State Change Ack +activate "CLAMP Runtime" deactivate Participant + "CLAMP Runtime" -> "CLAMP Database": Remove Restarting from all Compositions \n and Instances of this Participant +deactivate "CLAMP Runtime" + end @enduml diff --git a/docs/clamp/acm/api-protocol/system-level-dialogues.rst b/docs/clamp/acm/api-protocol/system-level-dialogues.rst index 6be26e18..49521882 100644..100755 --- a/docs/clamp/acm/api-protocol/system-level-dialogues.rst +++ b/docs/clamp/acm/api-protocol/system-level-dialogues.rst @@ -22,7 +22,7 @@ Participant Registration is performed by a Participant when it starts up. It reg 1.2 Deregister a Participant ---------------------------- -Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime. The participant should already have cleared down all its ACM Element instances and set their states to "Not In Service". +Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime. .. image:: ../images/system-dialogues/DeregisterParticipant.png |