Merge branch 'add-initial-android-app-overview-diagram-droid-77'

2 files changed, 46 insertions, 0 deletions

diff --git a/android/docs/diagrams/overview.png b/android/docs/diagrams/overview.png
new file mode 100644
index 0000000000..e90006d14b
--- /dev/null
+++ b/android/docs/diagrams/overview.png
diff --git a/android/docs/diagrams/overview.puml b/android/docs/diagrams/overview.puml
new file mode 100644
index 0000000000..d073e67593
--- /dev/null
+++ b/android/docs/diagrams/overview.puml
@@ -0,0 +1,46 @@
+@startuml overview-diagram
+
+title Mullvad VPN Android app overview
+skinparam SequenceMessageAlign center
+skinparam componentStyle rectangle
+skinparam linetype polyline
+
+package "App process" as App {
+  component "App UI (fragments, compose, VMs etc)" as AppUI
+  component "Middle layer (repositories etc)" as AppMiddleLayer
+  component "Messenger" as AppMessenger
+}
+
+package "Vpn Service process" as VpnService {
+  component "VPN Service implementation" as VpnServiceImpl
+  component "Middle layer" as VpnMiddleLayer
+  component "Daemon (rust)" as Daemon
+  component "Messenger" as VpnMessenger
+}
+
+package "Tile Service process" as TileService {
+  component "Tile Service implementation" as TileServiceImpl
+  component "Middle layer" as TileMiddleLayer
+  component "Messenger" as TileMessenger
+}
+
+' Messenger (IPC) connections.
+' Also helps with alignment of plantuml packages.
+[AppMessenger] <-[#blue]r-> [VpnMessenger] : Binder
+[VpnMessenger] <-[#blue]r-> [TileMessenger] : Binder
+
+' App connections
+AppUI <-d-> AppMiddleLayer
+AppMiddleLayer <-d-> AppMessenger
+
+' Vpn service connections
+VpnServiceImpl <-d-> VpnMiddleLayer
+VpnServiceImpl <-[#cyan]r-> Daemon : FFI
+VpnMiddleLayer <-[#cyan]r-> Daemon : FFI
+VpnMiddleLayer <-d-> VpnMessenger
+
+' Tile service connections
+TileServiceImpl <-d-> TileMiddleLayer
+TileMiddleLayer <-d-> TileMessenger
+
+@enduml