From 8ef93c27157fea4769031e664e72360703a29fcc Mon Sep 17 00:00:00 2001
From: Philippe PITTOLI
Date: Thu, 26 May 2016 18:47:28 +0200
Subject: [PATCH] core : README
---
README.markdown | 44 +++++++++++++++++++++++---------------------
1 file changed, 23 insertions(+), 21 deletions(-)
diff --git a/README.markdown b/README.markdown
index 3b671af..e8e1617 100644
--- a/README.markdown
+++ b/README.markdown
@@ -2,25 +2,27 @@
## what the programs should do and how they interact
- * service : application providing a feature to others (windows, audio, …)
- * program : specific application (browser, instant messaging, …)
+ * service : application providing a feature to others (windows, audio, …)
+ * program : specific application (browser, instant messaging, …)
+
+ * [service] : service name
+ * [index] : process index in the program point of view
+ * [pindex] : process index in the service point of view
- * : service name
- * : process index in the program point of view
- * : process index in the service point of view
-
- 1. the service creates a pipe, named /tmp/
- 2. the program creates pipes named /tmp/$pid--{in,out}
- 3. the program prints in the pipe /tmp/ : $pid- version
- 4. depending on the configuration and service type, the service will
- * thread, to spare resources
- * fork, not to compromise the security
- 5. the service prints in /tmp/$pid--in
+ 1. the service creates a pipe, named /tmp/[service]
+ 2. the program creates pipes named /tmp/$pid-[index]-{in,out}
+ 3. the program prints in the pipe /tmp/[service] : $pid-[index] version
+ 4. depending on the configuration and service type, the service will
+
+ * thread, to spare resources
+ * fork, not to compromise the security
+
+ 5. the service prints [pindex] in /tmp/$pid-[index]-in
## pure "networking" view (what should go in the pipes)
- 1. the program prints in the pipe /tmp/ : $pid- version
- 2. the service prints in /tmp/$pid--in
+1. the program prints in the pipe /tmp/[service] : $pid-[index] version
+2. the service prints [pindex] in /tmp/$pid-[index]-in
# messages format
@@ -28,14 +30,14 @@ QUESTION : no CBOR for 1 & 2, or CBOR everywhere ?
## overview
- : value
+format "type : value"
- will be a simple byte :
+type will be a simple byte :
- * <0 - 15> : control, meta data
- * <16 - 127> : later use
- * <128 - 255> : application specific (windowing system, audio system, …)
+ * <0 - 15> : control, meta data
+ * <16 - 127> : later use
+ * <128 - 255> : application specific (windowing system, audio system, …)
-## CBOR table (draft)
+## CBOR table (TODO)
index | semantic