Skip to content

Commit

Permalink
docs: Added a diagram directory
Browse files Browse the repository at this point in the history
Added this directory to tack the protocol diagrams.
Initial added:
- Connection

Signed-off-by: Alba Hita Catala <ahitacat@redhat.com>
  • Loading branch information
ahitacat committed Jun 5, 2023
1 parent e0911a4 commit fc5f8eb
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions doc/diagrams/yggd-connection.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
sequenceDiagram
participant S as server
participant B as broker
participant Y as yggdrasil
participant D as DBus
participant W as workerEcho

par Connect
Y ->> D: Get dispatchers
Y ->> B: connect to broker
Note right of Y: "yggdrasil Set last will (Disconnect)"
Y ->> S: control/out {"type":"connection-status", "dispatchers":{}}
end
par Data Messages
S ->> Y: Data messages
Y ->> W: Data Message
end
par Control Messages
S ->> Y: Control Messages
and
Y ->> S: Event Message
end
par Disconnect
Note right of Y: "yggdrasil Disconnect"
B ->> S: control/out {"type":"connection-status","state":"offline"}
end
Empty file added doc/diagrams/yggd-data.mmd
Empty file.

0 comments on commit fc5f8eb

Please sign in to comment.