add missing doc/index.md from template

Kronos-Integration · Dec 6, 2020 · 11110c8 · 11110c8
1 parent 08e5a2f
commit 11110c8
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/doc/index.md b/doc/index.md
@@ -0,0 +1,25 @@
+index
+=====
+
+kronos-endpoint
+
+Named end of a communication channel.
+There are always two ends A sending and a receiving endpoint always belong together.
+
+![request forwarding](images/requestForwarding.svg)
+
+
+opposite endpoints
+===
+to represent the opposite data flow the notion of opposite endpoints
+is present.
+Optionally each endpoint has an opposite one
+
+![opposite endpoint](images/opposite.svg)
+
+connection states
+===
+when a working connection is established (isOpen)
+the result of hasBeenOpenend is preserved
+ans will be passed to willBeClosed(state)
+![connection states](images/states.svg)