summaryrefslogtreecommitdiff
path: root/src/analysis/db/protocol.h
diff options
context:
space:
mode:
authorCyrille Bagard <nocbos@gmail.com>2019-09-08 07:47:41 (GMT)
committerCyrille Bagard <nocbos@gmail.com>2019-09-08 07:47:41 (GMT)
commitfbb80d00d8ac456451963d52af24fcccbbc1d751 (patch)
tree232d2f63378bf30db17c33c399cedc28fc13d4f9 /src/analysis/db/protocol.h
parent1a85f36e0505d75a51ab7b7f2c5078da7ef6bd98 (diff)
Updated the database protocol for bookmarks.
Diffstat (limited to 'src/analysis/db/protocol.h')
-rw-r--r--src/analysis/db/protocol.h47
1 files changed, 27 insertions, 20 deletions
diff --git a/src/analysis/db/protocol.h b/src/analysis/db/protocol.h
index 1c03d62..5c3eed6 100644
--- a/src/analysis/db/protocol.h
+++ b/src/analysis/db/protocol.h
@@ -114,7 +114,28 @@ typedef enum _DBCommand
{
DBC_HELO, /* Connexion initiale C -> S */
DBC_WELCOME, /* Réponse initiale S -> C */
+
+ /**
+ * Gestion de la commande 'DBC_SAVE'.
+ *
+ * Le client connecté envoie un paquet de la forme suivante :
+ *
+ * [ Ordre de sauvegarde : DBC_SAVE ]
+ *
+ * Le serveur s'exécute et renvoie un bilan :
+ *
+ * [ Ordre de sauvegarde : DBC_SAVE ]
+ * [ Statut d'exécution ; cf. DBError ]
+ *
+ * Les traitements se réalisent dans :
+ * - g_db_client_save() pour la partie client en émission.
+ * - g_cdb_archive_process() pour la partie serveur.
+ * - g_db_client_update() pour la partie client en réception.
+ *
+ */
+
DBC_SAVE, /* Enregistrement de l'archive */
+
DBC_COLLECTION, /* Implication d'une collection*/
/**
@@ -131,6 +152,7 @@ typedef enum _DBCommand
* De son côté, le serveur répond par une requête :
*
* [ Notification de maj : DBC_SET_ALL_ITEMS ]
+ * [ marqueur de démarrage : octet 0x1 ]
*
* Dans la foulée, il enverra ensuite les éléments avec des paquets classiques :
*
@@ -138,6 +160,11 @@ typedef enum _DBCommand
* [ Action : DBA_ADD_ITEM ]
* ...
*
+ * La séquence se termine par une requête finale :
+ *
+ * [ Notification de maj : DBC_SET_ALL_ITEMS ]
+ * [ marqueur de fin : octet 0x0 ]
+ *
* Les traitements se réalisent dans :
* - g_db_client_update() pour la partie client.
* - g_cdb_archive_process() pour la partie serveur.
@@ -202,26 +229,6 @@ typedef enum _DBError
-/**
- * Gestion de la commande 'DBC_SAVE'.
- *
- * Le client connecté envoie un paquet de la forme suivante :
- *
- * [ Ordre de sauvegarde : DBC_SAVE ]
- *
- * Le serveur s'exécute et renvoie un bilan :
- *
- * [ Ordre de sauvegarde : DBC_SAVE ]
- * [ Statut d'exécution ; cf. DBError ]
- *
- * Les traitements se réalisent dans :
- * - g_db_client_save() pour la partie client en émission.
- * - g_cdb_archive_process() pour la partie serveur.
- * - g_db_client_update() pour la partie client en réception.
- *
- */
-
-