From 602d60248baf158dba2e89e8c57230b1ba542435 Mon Sep 17 00:00:00 2001
From: David Anderson <davidpanderson@users.noreply.github.com>
Date: Tue, 19 Sep 2023 18:00:07 -0700
Subject: [PATCH] Created API Implementation (markdown)

---
 API-Implementation.md | 56 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 API-Implementation.md

diff --git a/API-Implementation.md b/API-Implementation.md
new file mode 100644
index 0000000..1672c1a
--- /dev/null
+++ b/API-Implementation.md
@@ -0,0 +1,56 @@
+## Communication
+
+The client and the app communicate through several shared-memory message-passing channels:
+
+### Messages from client to app
+
+#### process_control_request
+```xml
+<quit/>
+<abort/>
+<suspend/>
+<resume/>
+<reread_app_info/>
+<network_available/>
+```
+#### heartbeat
+```xml
+<heartbeat>
+<wss>
+<max_wss>
+<network_suspended>
+```
+
+#### trickle_down
+```xml
+<have_new_trickle_down/>
+```
+#### graphics_request
+
+Not used
+
+### Messages from app to client
+
+#### app_status
+```xml
+<current_cpu_time>...
+<checkpoint_cpu_time>...
+<working_set_size>...
+<fraction_done> ...
+```
+
+#### trickle_up
+
+```xml
+<have_new_trickle_up/>
+```
+
+#### process_control_reply
+
+Not used
+
+#### graphics_reply
+```xml
+<web_graphics_url>
+<remote_desktop_addr>
+```