From 6008e999eea82bb4355b086453be42414a4d60c9 Mon Sep 17 00:00:00 2001 From: drebs Date: Thu, 4 May 2017 15:05:40 +0200 Subject: [doc] cleanup old documentation --- docs/sphinx/sync.rst | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) (limited to 'docs/sphinx/sync.rst') diff --git a/docs/sphinx/sync.rst b/docs/sphinx/sync.rst index f243befb..b9d4c858 100644 --- a/docs/sphinx/sync.rst +++ b/docs/sphinx/sync.rst @@ -1,31 +1,34 @@ Soledad sync process ==================== +TODO: this documentation needs to be updated to account for new streaming encryption method. + Phases of sync: -(1) client acquires knowledge about server state. http GET -(2) client sends its documents to the server. http POSTs, or a single POST. -(3) client downloads documents from the server. -(4) client records its new state on the server. +1. client acquires knowledge about server state. +2. client sends its documents to the server. +3. client downloads documents from the server. +4. client records its new state on the server. Originally in u1db: -    (1) is a GET, -    (2) and (3) are one POST (send in body, receive in response), -    (4) is a PUT. + +* **1** is a GET, +* **2** and **3** are one POST (send in body, receive in response), +* **4** is a PUT. In soledad: -(1) is a GET. -(2) is either 1 or a series of sequential POSTS. -  (2.1) encrypt asynchronously -  (2.2) store in temp sync db -  (2.3) upload sequentially ***THIS IS SLOW*** -(3) is a series of concurrent POSTS, insert sequentially on local client db. -  (3.1) download concurrently -  (3.2) store in temp sync db -  (3.3) decrypt asynchronously -  (3.4) insert sequentially in local client db -(4) is a PUT. +* **1** is a GET. +* **2** is either 1 or a series of sequential POSTS. + * **2.1** encrypt asynchronously + * **2.2** store in temp sync db +  * **2.3** upload sequentially +* **3** is a series of concurrent POSTS, insert sequentially on local client db. + * **3.1** download concurrently +  * **3.2** store in temp sync db +  * **3.3** decrypt asynchronously +  * **3.4** insert sequentially in local client db +* **4** is a PUT. This difference between u1db and soledad was made in order to be able to gracefully interrupt the sync in the middle of the upload or the download. -- cgit v1.2.3